{"openapi":"3.1.0","info":{"title":"Payouts","version":"1.0.0","description":"This resource is used for payout actions","contact":{"name":"Rainforest","email":"support@rainforestpay.com","url":"https://rainforestpay.com"}},"servers":[{"url":"https://api.sandbox.rainforestpay.com","description":"Sandbox server"},{"url":"https://api.rainforestpay.com","description":"Production server"}],"paths":{"/v1/payouts":{"post":{"operationId":"create_payout","summary":"Create payout","description":"Create a payout from a payout config. The merchant, the payout receiver, and the payout receiver's payment method status must be `ACTIVE`.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request to create a payout from a payout config to an onboarded payout receiver. The merchant's balance is debited and the funds are sent to the payout receiver's payment method.","type":"object","properties":{"payout_config_id":{"description":"The unique payout config identifier.\n\nPrefix is \"pyc\" in production and \"sbx_pyc\" in sandbox.","type":"string","example":"pyc_33F8uybrmDPypCLAmKYsC30YKaN"},"payout_receiver_id":{"description":"The unique payout receiver identifier.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","type":"string","example":"rcv_2A4d6U0tMyovzTbVT1ktmRzdRaD"},"payout_receiver_payment_method_id":{"description":"The unique payout receiver payment method identifier that associates the payout receiver to the payment method.\n\nPrefix is \"rpm\" in production and \"sbx_rpm\" in sandbox.","type":"string","example":"rpm_2DrDFJPutxE5AIbJSopAnqniEbr"},"category":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/default_payout_category","description":"The category of the payout."},"rail":{"description":"The payout rail.","$ref":"#/paths/~1v1~1payout_configs~1{payout_config_id}/get/parameters/2/schema/items","default":"ACH"},"amount":{"description":"The amount of the payout, in minor units.\n\nFor example, 150000 is 1,500.00 USD.","type":"integer","minimum":1,"example":1000},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"requested_payout_date":{"description":"The requested date to process the payout, in ISO 8601 format (YYYY-MM-DD). The payout will be scheduled to process on the next available date relative to the requested date and returned in the `scheduled_payout_date`. When omitted, the payout is scheduled to process at the earliest available date.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date"},"metadata":{"description":"Valid JSON key-value object specified by the platform to store additional information. Do not use the metadata field to store sensitive or confidential data.\n\nMetadata must be less than 8 KB in size.\n","type":"object","example":{"key1":"value1","key2":{"inner_key1":"inner_value1"}}}},"required":["payout_config_id","payout_receiver_payment_method_id","amount","currency_code"]},"examples":{"minimal":{"value":{"payout_config_id":"pyc_33F8uybrmDPypCLAmKYsC30YKaN","payout_receiver_payment_method_id":"rpm_2DrDRpyAdp5MPUJnrJmoZcMmtfF","amount":1000,"currency_code":"USD"}},"all_fields":{"value":{"payout_config_id":"pyc_33F8uybrmDPypCLAmKYsC30YKaN","payout_receiver_id":"rcv_2A4d6U0tMyovzTbVT1ktmRzdRaD","payout_receiver_payment_method_id":"rpm_2DrDRpyAdp5MPUJnrJmoZcMmtfF","rail":"ACH","amount":1000,"currency_code":"USD","requested_payout_date":"2022-01-01","metadata":{"invoice_id":"inv_1234"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"payout_id":{"description":"The unique payout identifier.\n\nPrefix is \"pyo\" in production and \"sbx_pyo\" in sandbox.","type":"string","example":"pyo_33F8uybrmDPypCLAmKYsC30YKaN"},"payout_config_id":{"$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/payout_config_id","description":"The unique payout config identifier.\n\nPrefix is \"pyc\" in production and \"sbx_pyc\" in sandbox."},"merchant_id":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/merchant_id","description":"The unique merchant identifier.\n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox."},"payout_receiver_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data/properties/payout_receiver_id","description":"The unique payout receiver identifier.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox."},"payment_method_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/payment_method_id","description":"The unique payment method identifier.\n\nPrefix is \"mtd\" in production and \"sbx_mtd\" in sandbox."},"category":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/default_payout_category","description":"The category of the payout.","nullable":true},"idempotency_key":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/idempotency_key"},"amount":{"description":"The amount of the payout, in minor units.\n\nFor example, 150000 is 1,500.00 USD.","type":"integer","minimum":1},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"billing_fee":{"description":"The payout fee billed to the merchant.","type":"object","properties":{"amount":{"description":"The amount of the payout fee, in minor units.\n\nFor example, 20 is 0.20 USD.","type":"integer"},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}}},"status":{"$ref":"#/paths/~1v1~1payouts/get/parameters/3/schema/items"},"requested_payout_date":{"description":"The requested date to process the payout, in ISO 8601 format (YYYY-MM-DD). The payout will be scheduled to process on the next available date relative to the requested date and returned in the `scheduled_payout_date`. When omitted, the payout is scheduled to process at the earliest available date.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date","nullable":true},"scheduled_payout_date":{"description":"The date the payout is scheduled to process on.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date"},"estimated_arrival_date":{"description":"The estimated date the payout funds will arrive in the payout receiver's bank account.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date","nullable":true},"trace_number":{"description":"The ACH trace number of the payout. Null until the payout has been sent.","type":"string","nullable":true},"metadata":{"$ref":"#/paths/~1v1~1payouts/post/requestBody/content/application~1json/schema/properties/metadata"},"cancel_reason":{"nullable":true,"description":"The reason the payout was canceled.","type":"string","maxLength":255,"example":"Duplicate payout request"},"failure_code":{"nullable":true,"description":"The code explaining the reason the payout failed.\n\nThis value will be set if the payout status is `FAILED`.\n\n- `PAYOUT_RECEIVER_INACTIVE` - The payout receiver is not active and cannot process payouts.\n- `PAYOUT_RECEIVER_NEEDS_METHOD` - The payout receiver does not have an active payment method to process payouts.\n- `MERCHANT_INACTIVE` - The merchant is not active and cannot process payouts.\n- `FAILED` - The payout failed to process.","type":"string","enum":["PAYOUT_RECEIVER_INACTIVE","PAYOUT_RECEIVER_NEEDS_METHOD","MERCHANT_INACTIVE","FAILED"],"example":"FAILED","readOnly":true},"failure_desc":{"nullable":true,"description":"The description explaining the reason the payout failed. This will be a human-readable value that may be presented to the end user.","type":"string","examples":["The payout receiver is not active","The payout receiver does not have an active payment method","The merchant is not active","The payout failed to process"],"readOnly":true},"return_code":{"$ref":"#/paths/~1v1~1payouts~1{payout_id}~1simulate/post/requestBody/content/application~1json/schema/properties/return_code","nullable":true,"description":"The ACH return code explaining the reason the payout was returned.\n\nThis value will be set if the payout status is `RETURNED`."},"return_desc":{"nullable":true,"description":"The description explaining the reason the payout was returned. This will be a human-readable value that may be presented to the end user.","type":"string","examples":["Insufficient Funds","Account Closed","Corporate Customer Advises Not Authorized"],"readOnly":true},"merchant":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant","description":"The minimal representation of the merchant."},"payout_receiver":{"description":"The minimal representation of the payout receiver.","type":"object","properties":{"payout_receiver_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data/properties/payout_receiver_id","readOnly":true},"name":{"description":"The friendly display name for the payout receiver.","type":"string","readOnly":true},"type":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/2/schema/items","readOnly":true}}},"created_at":{"description":"Date and time the payout was created at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at"},"updated_at":{"description":"Date and time the payout was last updated at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true},"scheduled_at":{"description":"Date and time the payout was scheduled at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at"},"processed_at":{"description":"Date and time the payout was processed at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true},"canceled_at":{"description":"Date and time the payout was canceled at in UTC RFC 3339 format.\n\nThis value will be set if the payout status is `CANCELED`.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true},"failed_at":{"description":"Date and time the payout failed at in UTC RFC 3339 format.\n\nThis value will be set if the payout status is `FAILED`.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true},"returned_at":{"description":"Date and time the payout was returned at, in UTC RFC 3339 format.\n\nThis value will be set if the payout status is `RETURNED`.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/paths/~1v1~1payouts/get/responses/400/content/application~1json/schema"},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"EntityNotFound","message":"Resource not found"}]}}}},"409":{"description":"Conflict on the requested resource.","content":{"application/json":{"schema":{"$ref":"#/paths/~1v1~1payouts/get/responses/400/content/application~1json/schema"},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"string","message":"Conflict"}]}}}},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]},"get":{"operationId":"list_payouts","summary":"List payouts","description":"Query a list of payouts given optional search criteria.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"in":"header","name":"Rainforest-Api-Version","schema":{"type":"string","default":"2024-10-16","enum":["2024-10-16","2023-12-01"]}},{"in":"query","name":"merchant_id","schema":{"type":"string"},"description":"The unique merchant identifier. \n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox.","examples":{"production":{"value":"mid_2DrDFJPutxE5AIbJSopAnqniEbr"},"sandbox":{"value":"sbx_mid_2DrDFJPutxE5AIbJSopAnqniEbr"}}},{"in":"query","name":"payout_receiver_id","schema":{"type":"string"},"description":"The unique payout receiver identifier.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","examples":{"production":{"value":"rcv_2DrDFJPutxE5AIbJSopAnqniEbr"},"sandbox":{"value":"sbx_rcv_2DrDFJPutxE5AIbJSopAnqniEbr"}}},{"name":"status","in":"query","description":"One or more payout statuses to filter by. Provide parameter multiple times to filter by multiple payout statuses.\n\n`SCHEDULED` `IN_REVIEW` `PROCESSING` `SUCCEEDED` `FAILED` `RETURNED` `CANCELED`","schema":{"type":"array","items":{"description":"The status of the payout.","type":"string","enum":["SCHEDULED","IN_REVIEW","PROCESSING","SUCCEEDED","FAILED","RETURNED","CANCELED"],"example":"SCHEDULED"}}},{"in":"query","name":"scheduled_payout_date.start","description":"Scheduled to process on or after, in ISO 8601 format (YYYY-MM-DD).","schema":{"type":"string","format":"date"},"example":"2022-01-01"},{"in":"query","name":"scheduled_payout_date.end","description":"Scheduled to process on or before, in ISO 8601 format (YYYY-MM-DD).","schema":{"type":"string","format":"date"},"example":"2022-01-31"},{"in":"query","name":"scheduled_at.start","description":"Scheduled on or after in UTC RFC 3339 format.","schema":{"type":"string","format":"date-time"},"example":"2022-01-01T12:00:00Z"},{"in":"query","name":"scheduled_at.end","description":"Scheduled on or before in UTC RFC 3339 format.","schema":{"type":"string","format":"date-time"},"example":"2022-01-31T12:00:00Z"},{"name":"sort_by","in":"query","description":"Optional value by which to sort the result set. Default sort by is scheduled_at.","schema":{"type":"string","enum":["scheduled_at","scheduled_payout_date","created_at"]}},{"in":"query","name":"sort_order","description":"Order in which to return the sorted results; ascending or descending. Default sort order is descending.","schema":{"type":"string","enum":["asc","desc"]}},{"in":"query","name":"limit","schema":{"type":"number","default":1000,"maximum":1000},"description":"The maximum number of results to return."},{"in":"query","name":"start_key","schema":{"type":"string"},"description":"A key used to indicate the starting point for the next page of results. This value should be set to the last_key returned by the previous paginated request."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"Status of the request.\n\nIf the request status code is 2XX, then the `status` will be `SUCCESS`. If the request status code is 4XX or 5XX, then the `status` will be `ERROR`.","type":"string","enum":["SUCCESS","ERROR"],"example":"SUCCESS"},"data":{"type":"object","properties":{"last_key":{"name":"last_key","schema":{"type":"string"},"description":"Last ID in this result set.\n\nThis value can be be used as `start_key` in subsequent paginated requests to retrieve additional results whose IDs are greater than the `last_key` value."},"results":{"description":"List of payouts.","type":"array","items":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data"}}}},"errors":{"description":"List of errors, if applicable.","type":"array","items":{"type":"object","description":"Details of the error.","properties":{"field":{"description":"The field in the request that had an error, if applicable.","type":"string"},"code":{"description":"The code describing the error.","type":"string"},"message":{"description":"The description of the error related to the field.","type":"string"}}},"example":null}}}}}},"400":{"description":"Bad request, check for validation errors.","content":{"application/json":{"schema":{"description":"Default response object.","type":"object","properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"description":"Generic data object specified per resource, null if there are request errors.","type":"object","example":null,"nullable":true,"readOnly":true},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"RequestBody","message":"Invalid request payload"}]}}}},"401":{"description":"Authorization missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/paths/~1v1~1payouts/get/responses/400/content/application~1json/schema"},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"AuthUnauthorized","message":"Unauthorized"}]}}}},"403":{"description":"Authorization insufficient for requested action.","content":{"application/json":{"schema":{"$ref":"#/paths/~1v1~1payouts/get/responses/400/content/application~1json/schema"},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"AuthForbidden","message":"Forbidden"}]}}}},"5XX":{"description":"Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/paths/~1v1~1payouts/get/responses/400/content/application~1json/schema"},"example":{"status":"ERROR","data":null,"errors":[{"field":"string","code":"string","message":"Internal Server Error"}]}}}}},"tags":["Payouts"]}},"/v1/payouts/{payout_id}":{"get":{"operationId":"get_payout","summary":"Get payout","description":"Get payout details by the payout ID.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"in":"path","required":true,"name":"payout_id","schema":{"type":"string"},"description":"The unique payout identifier.\n\nPrefix is \"pyo\" in production and \"sbx_pyo\" in sandbox.","examples":{"production":{"value":"pyo_33F8uybrmDPypCLAmKYsC30YKaN"},"sandbox":{"value":"sbx_pyo_33F8uybrmDPypCLAmKYsC30YKaN"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]},"patch":{"operationId":"update_payout","summary":"Update payout","description":"Update supported fields on a payout. Only fields included in the payload will be updated. Omitted fields will not be updated.\n\nThe following fields can be updated when the payout is in the status of `SCHEDULED`: `amount`, `requested_payout_date`, and `metadata`.\n\nThe following fields can be updated when the payout is any status: `metadata`\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1payouts~1{payout_id}/get/parameters/1","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Update supported fields on a payout. Only fields included in the payload will be updated. Omitted fields will not be updated.\n\nThe following fields can be updated when the payout is in the status of `SCHEDULED`: `amount`, `requested_payout_date`, and `metadata`.\n\nThe following fields can be updated when the payout is any status: `metadata`","type":"object","properties":{"amount":{"description":"The amount of the payout, in minor units.\n\nFor example, 150000 is 1,500.00 USD.","type":"integer","minimum":1,"example":1000},"requested_payout_date":{"description":"The requested date to process the payout, in UTC RFC 3339 date format.\n\nThe payout will be scheduled to process on the next available date relative to the requested date and returned in the `scheduled_payout_date`.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date"},"metadata":{"description":"Valid JSON key-value object specified by the platform to store additional information. Do not use the metadata field to store sensitive or confidential data.\n\nUpdating metadata will merge with the existing metadata stored on the payout by the top-level key. If the same top-level key is passed in this request, it will overwrite the value stored on the payout. Only keys included in the payload will be updated. To remove a key, set the key's value to null. To remove all metadata pass null for the metadata value.\n\nMetadata must be less than 8 KB in size.","type":"object","nullable":true,"example":{"key1":"value1","key2":{"inner_key1":"inner_value1"}}}}},"examples":{"amount":{"value":{"amount":1500}},"requested_payout_date":{"value":{"requested_payout_date":"2022-01-05"}},"metadata":{"value":{"metadata":{"invoice_id":"inv_1234"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payouts/{payout_id}/cancel":{"post":{"operationId":"cancel_payout","summary":"Cancel payout","description":"Cancel a payout that is in the status of `SCHEDULED` or `IN_REVIEW`.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1payouts~1{payout_id}/get/parameters/1","in":"path"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"description":"Request to cancel a payout.","type":"object","properties":{"cancel_reason":{"description":"The reason for the cancellation.","type":"string","maxLength":255,"example":"Duplicate payout request"}}},"example":{"cancel_reason":"Duplicate payout request"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payouts/{payout_id}/simulate":{"post":{"operationId":"simulate_payout","summary":"Simulate payout status change","description":"Only available in the Rainforest sandbox environment. Simulate a payout status change. Rainforest will simulate the life cycle of a payout to transition to the requested status. The expected webhooks will be sent for the payout on each status change.\n\n- `PROCESSING` from `SCHEDULED`\n- `SUCCEEDED` from `SCHEDULED` or `PROCESSING`\n- `FAILED` from `SCHEDULED` or `PROCESSING`. Requires a `failure_code`.\n- `RETURNED` from `SCHEDULED`, `PROCESSING` or `SUCCEEDED`. Requires an ACH `return_code`.\n- `CANCELED` from `SCHEDULED` or `IN_REVIEW`. Accepts an optional `cancel_reason`.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1payouts~1{payout_id}/get/parameters/1","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Simulation request for transitioning payout status.","type":"object","properties":{"status":{"description":"Status to transition the payout to. The payout will advance through any intermediate statuses.","type":"string","enum":["PROCESSING","SUCCEEDED","FAILED","RETURNED","CANCELED"],"example":"SUCCEEDED"},"failure_code":{"description":"The failure code for the payout. Required when `status` is `FAILED`.","type":"string","enum":["PAYOUT_RECEIVER_INACTIVE","MERCHANT_INACTIVE","FAILED"],"example":"FAILED"},"return_code":{"description":"The ACH return code for the payout. Required when `status` is `RETURNED`.\nAn ACH return code of `R02`, `R03`, `R04` and `R20` will deactivate the payout receiver's payment method.","type":"string","nullable":false,"enum":["R01","R02","R03","R05","R06","R07","R08","R09","R10","R11","R12","R13","R14","R15","R16","R17","R18","R19","R20","R21","R22","R23","R24","R25","R26","R27","R28","R29","R30","R31","R32","R33","R34","R35","R36","R37","R38","R39","R40","R41","R42","R43","R44","R45","R46","R47","R50","R51","R52","R53","R61","R62","R67","R68","R69","R70","R71","R72","R73","R74","R75","R76","R77","R80","R81","R82","R83","R84","R85"],"readOnly":true},"cancel_reason":{"description":"The free-form cancellation reason for the payout. Only valid when `status` is `CANCELED`.","type":"string","maxLength":255,"example":"Duplicate payout request"}},"required":["status"]},"examples":{"succeeded":{"value":{"status":"SUCCEEDED"}},"failed":{"value":{"status":"FAILED","failure_code":"FAILED"}},"returned":{"value":{"status":"RETURNED","return_code":"R01"}},"canceled":{"value":{"status":"CANCELED","cancel_reason":"Duplicate payout request"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/merchants/{merchant_id}/simulate_complete_payments":{"post":{"operationId":"simulate_merchant_complete_payins","summary":"Simulate merchant payins complete","description":"Only available in the Rainforest sandbox environment.\n\nSimulates completing all pending payment activity on a merchant. Any payins or refunds with the status of `PROCESSING` will be transitioned to the status of `SUCCEEDED`. The funds will then be included in the merchant's available balance.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","description":"The merchant's balance after the payment activity is completed.","properties":{"available_balance":{"type":"object","description":"Funds available to be paid out in the next deposit.","properties":{"amount":{"type":"integer","description":"The amount, in minor units. May be negative when refunds or fees exceed payins."},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}}},"pending_balance":{"type":"object","description":"Funds not yet available to be paid out.","properties":{"amount":{"type":"integer","description":"The amount, in minor units."},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}}}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"409":{"$ref":"#/paths/~1v1~1payouts/post/responses/409"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Deposits"]}},"/v1/top_up_quotes":{"get":{"operationId":"get_top_up_quote","summary":"Get top-up quote","description":"The quote calculates the total amount of the top-up, including the top-up fee, and estimates when the top-up is processed and the funds become available.\n\nA top-up quote can be provided for either a `payment_method_id` or `payment_method_type`.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1payouts/get/parameters/1","in":"query","required":true},{"name":"payment_method_id","in":"query","description":"The unique payment method identifier.\n\nPrefix is \"mtd\" in production and \"sbx_mtd\" in sandbox.","schema":{"type":"string"},"example":"mtd_2DrDRpyAdp5MPUJnrJmoZcMmtfF"},{"name":"payment_method_type","in":"query","description":"The type of payment method.","schema":{"description":"The type of payment method.","type":"string","enum":["CARD","APPLE_PAY","GOOGLE_PAY","ACH","PLAID_ACH","PAYPAL_WALLET","VENMO","PAYPAL_PAYLATER"]}},{"name":"amount","in":"query","required":true,"description":"The net amount to add to the merchant's balance after fees, in minor units.\n\nFor example, 100000 is 1,000.00 USD.","schema":{"type":"integer","minimum":1},"example":100000},{"name":"currency_code","in":"query","required":true,"schema":{"description":"Three-letter ISO currency code, in uppercase. Currently, only USD is supported.","type":"string","example":"USD","enum":["USD"],"maxLength":3,"minLength":3}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"net_amount":{"description":"The amount to add to the merchant’s balance, in minor units.","type":"integer","example":100000},"fee":{"description":"The payin fee for the top-up, in minor units.\n\nFor a merchant on `NET` billing, the fee is deducted from the payin amount, so it is included in `total_debit`.\n\nFor a merchant on GROSS billing, the fee is billed separately and is not included in `total_debit`.","type":"integer","example":3017},"total_debit":{"description":"The total amount to debit from the payment method, in minor units. Use this as the `amount` when creating the top-up payin config.\n\nFor a merchant on `NET` billing, this is `net_amount` plus `fee`.\n\nFor a merchant on `GROSS` billing, this equals `net_amount`.","type":"integer","example":103017},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"debit_date":{"description":"The estimated date the payment method is debited.","type":"string","format":"date","example":"2022-01-01"},"available_date":{"description":"The estimated date the funds become available in the merchant's balance. Set to `null` when the merchant does not have funding deposits enabled.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date","nullable":true}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payin_configs/top_up":{"post":{"operationId":"create_top_up_payin_config","summary":"Create top-up payin config","description":"Create the configuration for a top-up payin to top up a merchant's balance. Top-up payin configs only support specifying the amount. All other payin configurations are not applicable to top-ups.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"merchant_id":{"description":"The unique merchant identifier. \n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox.","type":"string","example":"mid_2DrDFJPutxE5AIbJSopAnqniEbr"},"idempotency_key":{"description":"A unique identifier provided by the platform. This key will be used to detect subsequent retries of the same request. Subsequent requests with the same key will return the result of the first request, regardless if the first request succeeded or failed. This identifier should be generated by the platform and can be max 255 characters.","type":"string","example":"e7d57c41-7626-4644-b777-9451ab3ddea9","maxLength":255,"minLength":1},"amount":{"description":"The amount to top up, in minor units.\n\nFor example, 100000 is 1,000.00 USD.","type":"integer","minimum":1,"example":100000},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}},"required":["merchant_id","idempotency_key","amount","currency_code"]},"examples":{"required_fields":{"value":{"merchant_id":"mid_2DrDFJPutxE5AIbJSopAnqniEbr","idempotency_key":"e7d57c41-7626-4644-b777-9451ab3ddea9","amount":100000,"currency_code":"USD"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"payin_config_id":{"readOnly":true,"description":"The unique payin config identifier. \n\nPrefix is \"cfg\" in production and \"sbx_cfg\" in sandbox.","type":"string","example":"cfg_2DrDPKzdQypRudLd8DhQKZX27dA"},"payment_method_config_id":{"readOnly":true,"description":"The unique payment method config identifier. \n\nPrefix is \"pmc\" in production and \"sbx_pmc\" in sandbox.","type":"string","example":"pmc_2DrDPKzdQypRudLd8DhQKZX27dA"},"merchant_id":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/merchant_id"},"merchant":{"type":"object","properties":{"id":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/merchant_id","readOnly":true},"name":{"readOnly":true,"description":"The unique identifier for the merchant business name.","type":"string","example":"Merchant","maxLength":100},"dba_name":{"readOnly":true,"description":"The merchant’s public-facing name. This may be the same as the legal name if the merchant does not operate under a different name. When creating or updating a merchant, this must be at least 5 characters. Existing merchants may have shorter values from before this requirement was introduced.","type":"string","example":"Merchant","maxLength":100}}},"idempotency_key":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/idempotency_key"},"type":{"readOnly":true,"description":"What the payin config is used for.\n\n`PAYIN` The payin config is used for a payin.\n\n`TOP_UP` The payin config is used to add funds to the merchant's balance. Only payment methods with the `TOP_UP` capability may be used with it.","type":"string","enum":["PAYIN","TOP_UP"],"example":"PAYIN"},"amount":{"description":"The total amount allowed to process, in minor units.\n\nFor example, 1000 is 10.00 USD.","type":"integer","example":100,"minimum":1},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"amount_splits":{"description":"Represents how the payin should be allocated between the originating merchant, the platform, and one or more other merchants.\n\nA `PLATFORM` split defines a platform fee on the payin. A maximum of one `PLATFORM` split is permitted per payin.\n\nA `MERCHANT` split allocates a portion of the payin to the specified merchant. Multiple `MERCHANT` splits are permitted. Each `MERCHANT` split must specify a unique merchant_id.\n\nAny remaining amount not specified by the amount splits will be allocated to the originating merchant associated with the payin.\n\nIf no amount splits are provided, the total amount will be allocated to the originating merchant.\n\nThe amount split is defined as a rate and amount. The split is calculated based on the pre-tip (when collecting a tip on a device) authorized amount of the payin.\n\nFor example, to assess a platform fee of 1% + $5.00, specify 1000 in the rate and 500 in the amount. Be careful to account for any processing fees that will be netted before computing amount splits.","type":"array","items":{"type":"object","properties":{"rate":{"description":"The amount split defined as a rate, in percent mille (1 PCM = 0.001%). The amount split will be calculated on the authorized amount of the payin.\n\nFor example, 3000 is 3%.","type":"integer","example":3000,"minimum":0},"rate_cap":{"description":"The amount split rate cap, in minor units. Used to cap the rate to a specified amount.\n\nFor example, 1000 is 10.00 USD.\n\nThe following validation must be met:\n  If the rate is greater than 0%, then the rate_cap must be greater than $0. For example, to bill a rate of 1% up to $100 set the value to 10000.\n  If the rate is 0%, then the rate_cap must be $0.","type":"integer","example":1000,"minimum":0},"amount":{"description":"The amount split, in minor units.\n\nFor example, 1000 is 10.00 USD.","type":"integer","example":3,"minimum":0},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"type":{"description":"The type of receiver for this split.\n\n`PLATFORM` allocates the split amount to the platform. `MERCHANT` allocates the split amount to the merchant specified by merchant_id.","type":"string","enum":["PLATFORM","MERCHANT"]},"merchant_id":{"description":"Required when type is `MERCHANT`.\n\nThe unique identifier of the merchant receiving this split. The merchant status must be ACTIVE.\n\nThe following constraints must be met:\n\n- Cannot match the merchant_id of the originating merchant on the payin.\n- Cannot be duplicated within the same amount_splits array.\n- Not valid when type is `PLATFORM`.\n\nPrefix is mid in production and sbx_mid in sandbox.","type":"string","example":"mid_abc123"},"amount_split_reversal_config":{"description":"Controls whether this amount split is reversed on a refund for the full amount or an ACH return. When not provided, both attributes default to false.","type":"object","properties":{"on_full_refund":{"description":"Determines whether this amount split is reversed when a refund for the full amount is processed on this payin.\n\nWhen `true`, the receiver's allocation is pulled back on the refund. When `false`, the receiver retains their allocation and the originating merchant absorbs this amount of the refund.\n\nThis configuration only applies to full refunds. For partial refunds, amount_splits on the refund request can be provided to specify the reversal amounts.","type":"boolean","default":false},"on_ach_return":{"description":"Determines whether this amount split is reversed when an ACH return is processed on this payin.\n\nWhen `true`, the receiver's allocation is pulled back on the ACH return. When `false`, the receiver retains their allocation and the originating merchant absorbs this amount of the ACH return.","type":"boolean","default":false}}}},"required":["amount","currency_code","type"]},"example":[{"amount":3,"currency_code":"USD","type":"PLATFORM"}],"maxItems":26,"minItems":0},"billing_fees_reversal_config":{"description":"Controls whether the billing fees for this payin are returned to the originating merchant on a refund for the full amount or an ACH return. When not provided, both attributes default to the merchant's configuration.","type":"object","properties":{"on_full_refund":{"description":"Determines whether the billing fees for this payin are returned to the merchant when a refund for the full amount is processed.\n\nWhen `true`, the billing fee is credited back to the merchant and included in the refund's computed billing fee.\n\nThis field can also be defined on the refund request and will take precedence over the configuration defined on this payin config.","type":"boolean","default":false},"on_ach_return":{"description":"Determines whether the billing fees for this payin are returned to the merchant when an ACH return is processed.\n\nWhen `true`, the billing fee is credited back to the merchant and included in the ACH return's computed billing fee.","type":"boolean","default":false}}},"merchant_billing":{"description":"The billing rate and fee to calculate the merchant's billing fee on the authorized amount of the payin.\n\nSet the top-level rate, rate cap, and fee to define a billing fee regardless of the payment method the end user pays with.\n\nSet one or more payment method objects to define separate billing fees for each payment method.\n\nSee the [dynamic payment billing fees guide](https://docs.rainforestpay.com/docs/dynamic-payment-billing-fees) for additional details on how Rainforest determines the billing fees for the payment.","type":"object","properties":{"rate":{"description":"Rate, in percent mille (1 PCM = 0.001%).\n\nFor example, 3000 is 3%.","type":"integer","minimum":0,"maximum":25000},"rate_cap":{"description":"Rate cap, in minor units. Used to cap the rate to a specified amount.\n\nFor example, 1000 is 10.00 USD.\n\nThe following validation must be met:\n- If the `rate` is greater than 0%, then the `rate_cap` must be greater than $0. For example, to bill a rate of 1% up to $100 set the value to `10000`.\n- If the `rate` is 0%, then the `rate_cap` must be $0.","type":"integer","minimum":0,"maximum":10000000},"fee":{"description":"Fee, in minor units. \n\nFor example, 1000 is 10.00 USD.\n\nThe fee can be up to $10, regardless of the amount of the payin. However, if the fee is greater than $10, then the fee cannot be greater than the `amount` field.\n\nValid requests: \n- Fee of $10 on a $5 payin. \n- Fee of $11 on a $20 payin.\n\nInvalid requests: \n- Fee of $11 on a $5 payin.","type":"integer","minimum":0},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"},"card":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"},"ach":{"description":"The billing rate and fee to calculate the merchant's billing fee for this specific payment method.\n\nThis takes precedence and overrides the rate and fee defined by the top-level merchant_billing object and the merchant's billing profile.","type":"object","properties":{"rate":{"description":"Rate, in percent mille (1 PCM = 0.001%).\n\nFor example, 3000 is 3%.","type":"integer","required":true,"minimum":0,"maximum":25000},"rate_cap":{"description":"Rate cap, in minor units. Used to cap the rate to a specified amount.\n\nFor example, 1000 is 10.00 USD.\n\nThe following validation must be met:\n- If the `rate` is greater than 0%, then the `rate_cap` must be greater than $0. For example, to bill a rate of 1% up to $100 set the value to `10000`.\n- If the `rate` is 0%, then the `rate_cap` must be $0.","type":"integer","required":true,"minimum":0,"maximum":10000000},"fee":{"description":"Fee, in minor units.\n\nFor example, 1000 is 10.00 USD.\n\nThe fee can be up to $10, regardless of the amount of the payin. However, if the fee is greater than $10, then the fee cannot be greater than the `amount` field.","type":"integer","required":true,"minimum":0},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema","required":true}}},"validated_ach":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"},"accelerated_ach":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"},"paypal_wallet":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"},"venmo":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"},"paypal_paylater":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach"}}},"allow_bin_lookup":{"description":"Boolean indicating if BIN data is returned when a user is inputting the card number into the Payment Component.","type":"boolean","default":false},"allow_partial_authorization":{"description":"Boolean indicating if partial amount can be authorized on a card payment, if supported by the issuing bank.","type":"boolean"},"billing_contact":{"description":"Billing contact details.\n\nWhen processing a payin or storing a payment method via the Payment Component, the `request_wallet_address` and `request_wallet_contact` fields can be set to request the billing contact address and contact information (email and phone) from the end user within the wallet flows.\n\nWhen processing a payin from a stored payment method, the billing contact set on the config will merge with the billing contact on the stored payment method. This allows the billing contact to be updated on a stored payment method.","allOf":[{"description":"Billing contact details.","type":"object","properties":{"name":{"description":"First and last name.","type":"string","example":"Jane Smith","maxLength":100},"address_line_1":{"description":"First line of street address.","type":"string","example":"123 Example Street","maxLength":100},"address_line_2":{"description":"Second line of street address, if required.","type":"string","example":"Suite 123","maxLength":100},"city":{"description":"City for address.","type":"string","example":"Atlanta","maxLength":100},"state":{"description":"State, province, or region for address.","type":"string","example":"GA","maxLength":100},"postal_code":{"description":"Postal code or ZIP code for address.","type":"string","example":"30305","maxLength":15},"country":{"description":"2-digit country code. \nFind country codes here: https://www.iso.org/obp","type":"string","example":"US","maxLength":2,"minLength":2},"email":{"description":"Email address.","type":"string","example":"janesmith@example.com","maxLength":100},"phone":{"description":"Phone number, including extension.","type":"string","example":"+14041234567","maxLength":100}}},{"type":"object","properties":{"request_wallet_address":{"description":"Request the end user's address when processing from a wallet in the Payment Component.\n\nSupported for Apple Pay, Google Pay, PayPal, Venmo, and PayPal Pay Later.\n\nThe `name`, `address_line_1`, `address_line_2`, `city`, `state`, `postal_code`, `country` collected from the wallet will be set on the payin and payment method and override the fields passed in the config.","type":"boolean","default":false},"request_wallet_contact":{"description":"Request the end user's contact details, including email and phone, when processing from a wallet in the Payment Component.\n\nEmail and phone are supported for Apple Pay, Google Pay, PayPal, Venmo, and PayPal Pay Later.\n\nThe contact details collected from the wallet will be set on the payin and payment method and override the fields passed in the config.","type":"boolean","default":false}}}]},"shipping_address":{"description":"Shipping address details.\n\nWhen processing a payin or storing a payment method via the Payment Component, the `request_wallet_address` field can be set to request the shipping address from the end user within the wallet flows.\n\nWhen processing a payin from a stored payment method, the shipping address set on the config will merge with the shipping address on the stored payment method. This allows the shipping address to be updated on a stored payment method.","allOf":[{"type":"object","properties":{"name":{"description":"Recipient's first and last name.","type":"string","example":"Jane Smith","maxLength":100},"address_line_1":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/address_line_1"},"address_line_2":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/address_line_2"},"city":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/city"},"state":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/state"},"postal_code":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/postal_code"},"country":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/responses/200/content/application~1json/schema/properties/data/properties/billing_contact/allOf/0/properties/country"}}},{"type":"object","properties":{"request_wallet_address":{"description":"Request the end user's shipping address when processing from a wallet in the Payment Component.\n\nSupported for Apple Pay and Google Pay.\n\nThe `name`, `address_line_1`, `address_line_2`, `city`, `state`, `postal_code`, `country` collected from the wallet will be set on the payin and payment method and override the fields passed in the config.","type":"boolean"}}}]},"risk_data":{"description":"Platform payment data that provides additional context to the risk review of the payin.","type":"object","properties":{"external_ref":{"description":"Platform identifier for the payin, such as an invoice ID or order ID.","type":"string","maxLength":100,"minLength":1},"end_user_ref":{"description":"Platform identifier for the end user processing the payin with the merchant, such as an account ID.","type":"string","maxLength":100,"minLength":1}}},"level_2_3":{"description":"Level 2 and Level 3 data is submitted with a business or commercial card to provide additional benefit to the cardholder through enhanced payin information, and benefits the merchant with lower interchange rates.","type":"object","properties":{"tax_amount":{"description":"The sales tax included in the total payin amount associated with the item(s) being purchased, in minor units.\n\nFor example, 1000 is 10.00 USD.","type":"integer"},"shipping_amount":{"description":"The freight or shipping amount included in the total payin amount, in minor units.\n\nFor example, 1000 is 10.00 USD.","type":"integer"},"order_number":{"description":"The purchase order number.","type":"string"},"shipping_country":{"description":"The 2-digit country code for the delivery address of the item(s) being purchased. \n\nFind country codes here: https://www.iso.org/obp","type":"string","example":"US","maxLength":2,"minLength":2},"shipping_postal_code":{"description":"Postal code or ZIP code for the delivery address of the item(s) being purchased. This field can be identical to the `shipping_from_postal_code` if the customer is present and takes immediate possession of the item(s).","type":"string","example":"30305"},"shipping_from_postal_code":{"description":"Postal code or ZIP code of the address the item(s) being purchased are shipped from.","type":"string","example":"30305"},"commodity_code":{"description":"The commodity code of the item(s) being purchased.","type":"string"},"line_items":{"description":"The details on the item(s) being purchased.","type":"array","items":{"type":"object","properties":{"product_code":{"description":"The merchant defined product code of the item being purchased.","type":"string"},"commodity_code":{"description":"The commodity code of the item being purchased.","type":"string"},"description":{"description":"The description of the item being purchased.","type":"string"},"unit_amount":{"description":"The amount of the item being purchased, in minor units. Defaults to 0.\n\nFor example, 1000 is 10.00 USD.","type":"integer","default":0},"unit_of_measure":{"description":"A unit of measure as used in international trade, such as each, gallons, feet, etc. Defaults to EACH.","type":"string","default":"EACH"},"quantity":{"description":"The quantity of the item.","type":"integer"},"total_amount":{"description":"The total amount of the item being purchased, in minor units. Defaults to (unit_amount x quantity) - discount_amount, rounded to the nearest penny.\n\nFor example, 1000 is 10.00 USD.","type":"integer"},"tax_amount":{"description":"The sales tax on the item being purchased, in minor units. Defaults to 0.\n\nFor example, 1000 is 10.00 USD.","type":"integer","default":0},"tax_rate":{"description":"The percentage representing the value-added tax applied, in per cent mille. Defaults to 0.\n\nFor example, 1000 is 1%.","type":"integer","default":0,"maximum":100000},"discount_amount":{"description":"The discount on the item being purchased, in minor units. Defaults to 0.\n\nFor example, 1000 is 10.00 USD.","type":"integer","default":0},"discount_rate":{"description":"The percentage representing the discount applied, in per cent mille. Defaults to 0. \n\nFor example 1000 is 1%.","type":"integer","default":0,"maximum":100000}}}}}},"metadata":{"description":"Valid JSON key-value object specified by the platform to store additional information. Keys are queryable in list endpoints. Do not use the metadata field to store sensitive or confidential data.\n\nMetadata must be less than 8 KB in size.\n","type":"object","example":{"key1":"value1","key2":{"inner_key1":"inner_value1"}},"minLength":0},"method_metadata":{"description":"Valid JSON key-value object specified by the platform to store additional information on the payment method. Keys are queryable in list endpoints. Do not use the metadata field to store sensitive or confidential data.\n\nMetadata must be less than 8 KB in size.\n","type":"object","example":{"key1":"value1","key2":{"inner_key1":"inner_value1"}},"minLength":0},"processing_mode":{"description":"Determines how to process the payin when [creating the payin](ref:create_payin) via the Payment Component or the API.\n\nOptions:\n  * `AUTHORIZE` - Only authorize the payin, separating the authorization and capture of funds. Authorize will place a hold on the funds and the payin must be [captured](ref:capture_payin) in a separate request.\n  * `AUTHORIZE_AND_CAPTURE` - Authorize and capture the payin in a single request (default).","type":"string","default":"AUTHORIZE_AND_CAPTURE","enum":["AUTHORIZE","AUTHORIZE_AND_CAPTURE"]},"threeds_mode":{"description":"Determines how 3D Secure authentication should be run on this payment to verify that the customer initiating the payment is actually the cardholder.\n\n3D Secure is only available on credit card payments via the Rainforest payment component. This mode is ignored if the payment is made by ACH, or when charging a stored payment method.\n\nOptions:\n* `NONE` - 3D Secure will not be run (default).\n* `ATTEMPT`-  The payment component will attempt to run 3D Secure. If 3D Secure is not available or fails, the payment will process without 3D Secure verification.","type":"string","default":"NONE","enum":["NONE","ATTEMPT"]},"device_signature_mode":{"description":"Determines if a signature should be collected when processing a payment on a device\n\nOptions:\n  * `NONE` - Signature will not be collected\n  * `ATTEMPT` - Only prompt for a signature on devices that support the signature capability","type":"string","default":"NONE","enum":["NONE","ATTEMPT"]},"device_allow_manual_entry":{"description":"Boolean indicating if the cardholder can manually key in their card details when processing a payment on a device, instead of presenting the card.","type":"boolean","default":false},"device_tip_config":{"nullable":true,"type":"object","description":"Configures a preset tip prompt of percentages or amounts to request a tip when processing a payment on a device. When requesting a tip, the end user will also have the ability to input a custom tip amount on the device.\n\nExactly one of `tip_percentages` or `tip_amounts` must be set.\n\nNot supported for separate authorization and capture (`processing_mode` of `AUTHORIZE`). The payment must be authorized and captured in a single request in order to request a tip.\n\nUp to 4 presets may be configured, but some devices can only display up to 3 presets. Presets displayed will be in the order they are provided and any beyond the number supported on the device will not be displayed. For example, if tip_percentages is set to [20000, 18000, 15000, 10000] and the device only supports 3 presets, then the device will display 20%, 18%, and 15%.","properties":{"tip_percentages":{"description":"Preset tip percentages, in percent mille (1 PCM = 0.001%).\n\nFor example, [20000, 18000, 15000, 10000] will display 20%, 18%, 15%, and 10% on the device.","type":"array","items":{"type":"integer","minimum":1},"maxItems":4,"example":[20000,18000,15000]},"tip_amounts":{"description":"Preset tip amounts, in minor units.\n\nFor example, [1000, 500, 200, 100] will display $10.00, $5.00, $2.00, $1.00 on the device.","type":"array","items":{"type":"integer","minimum":1},"maxItems":4,"example":[500,300,100]}}},"ach_balance_check_mode":{"description":"ACH Balance Check is in beta: please contact your Customer Success contact for more information.\nDetermines if the balance of the account will be checked when processing a Validated ACH payin. If the balance does not cover the amount of the payin, the payin will fail with the refusal reason of insufficient funds.\n\nOptions:\n  * `NONE` - Account balance will not be checked\n  * `ATTEMPT` - Attempt to check the account balance is sufficient to process the payin","type":"string","default":"NONE","enum":["NONE","ATTEMPT"]},"payin":{"description":"The minimal representation of the payin successfully processed with the payin config, if applicable.\n\nIf no payin has been successfully processed with the payin config, `payin` will be `null`.","nullable":true,"readOnly":true,"type":"object","properties":{"payin_id":{"readOnly":true,"description":"The unique payin identifier. \n\nPrefix is \"pyi\" in production and \"sbx_pyi\" in sandbox.","type":"string","example":"pyi_2DrDKk5NIMbpuNGqm109SkpGDHh"}}}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payout_configs":{"post":{"operationId":"create_payout_config","summary":"Create payout config","description":"Create the configuration for a payout. The merchant must be `ACTIVE`.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request to create a payout config for a merchant. The payout config holds the configuration for a payout, such as the merchant, default payout receiver, payout fee override, and idempotency key, and is required to create a payout.","type":"object","properties":{"merchant_id":{"description":"The unique merchant identifier for the merchant the payouts are sent from.\n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox.","type":"string","example":"mid_2DrDFJPutxE5AIbJSopAnqniEbr"},"default_payout_receiver_id":{"description":"The unique payout receiver identifier to send the payout to when the create payout request does not set a `payout_receiver_id`.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","type":"string","example":"rcv_2A4d6U0tMyovzTbVT1ktmRzdRaD"},"idempotency_key":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/idempotency_key","description":"A unique identifier provided by the platform, unique per platform. Subsequent requests with the same key will return the payout config created by the first request. A subsequent request with the same key but a different request body will return a 409.\n\nThe payout created from the payout config inherits this idempotency key. This identifier should be generated by the platform and can be max 255 characters."},"merchant_billing":{"description":"Overrides the payout fee from the merchant's billing profile.","type":"object","properties":{"ach":{"description":"The payout fee override for payouts sent via ACH.","type":"object","properties":{"fee":{"description":"The payout fee, in minor units.\n\nFor example, 20 is 0.20 USD. The maximum fee is 10000 (100.00 USD).","type":"integer","minimum":0,"maximum":10000,"example":20},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}},"required":["fee","currency_code"]}},"required":["ach"]},"metadata":{"$ref":"#/paths/~1v1~1payouts/post/requestBody/content/application~1json/schema/properties/metadata"}},"required":["merchant_id","idempotency_key"]},"examples":{"minimal":{"value":{"merchant_id":"mid_2DrDFJPutxE5AIbJSopAnqniEbr","idempotency_key":"e7d57c41-7626-4644-b777-9451ab3ddea9"}},"all_fields":{"value":{"merchant_id":"mid_2DrDFJPutxE5AIbJSopAnqniEbr","default_payout_receiver_id":"rcv_2A4d6U0tMyovzTbVT1ktmRzdRaD","idempotency_key":"e7d57c41-7626-4644-b777-9451ab3ddea9","merchant_billing":{"ach":{"fee":25,"currency_code":"USD"}},"metadata":{"invoice_id":"inv_1234"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"payout_config_id":{"description":"The unique payout config identifier.\n\nPrefix is \"pyc\" in production and \"sbx_pyc\" in sandbox.","type":"string","example":"pyc_33F8uybrmDPypCLAmKYsC30YKaN"},"merchant_id":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/merchant_id","description":"The unique merchant identifier.\n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox."},"default_payout_receiver_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data/properties/payout_receiver_id","description":"The unique payout receiver identifier to send the payout to when the create payout request does not set a `payout_receiver_id`.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","nullable":true},"merchant_billing":{"description":"Overrides the payout fee from the merchant's billing profile.","type":"object","nullable":true,"properties":{"ach":{"description":"The payout fee override for payouts sent via ACH.","type":"object","properties":{"fee":{"description":"A payout fee, in minor units.","type":"object","properties":{"amount":{"description":"The amount of the payout fee, in minor units.\n\nFor example, 20 is 0.20 USD.","type":"integer","minimum":0,"example":20},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}}}}}}},"payout_fees":{"description":"The fee that will be charged for the payout per rail.","type":"array","items":{"type":"object","properties":{"rail":{"$ref":"#/paths/~1v1~1payout_configs~1{payout_config_id}/get/parameters/2/schema/items","description":"The payout rail."},"fee":{"$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_billing/properties/ach/properties/fee","description":"The payout fee on the rail."}}}},"idempotency_key":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/idempotency_key","description":"A unique identifier for the request. This key will be used to detect subsequent retries of the same request. Subsequent requests with the same key will return the result of the first request, regardless if the first request succeeded or failed. This identifier should be generated by the platform and can be max 255 characters."},"payout_id":{"$ref":"#/paths/~1v1~1payouts/post/responses/200/content/application~1json/schema/properties/data/properties/payout_id","description":"The unique payout identifier for the payout successfully processed with the payout config, if applicable. If no payout has been successfully processed with the payout config, the `payout_id` will be `null`.\n\nPrefix is \"pyo\" in production and \"sbx_pyo\" in sandbox.","nullable":true},"metadata":{"$ref":"#/paths/~1v1~1payouts/post/requestBody/content/application~1json/schema/properties/metadata","description":"Valid JSON key-value object specified by the platform to store additional information. Keys are queryable in list endpoints. Do not use the metadata field to store sensitive or confidential data. Metadata must be less than 8 KB in size."},"created_at":{"description":"Date and time the payout config was created at in UTC RFC 3339 format.","type":"string","format":"date-time","example":"2022-01-01T12:00:00Z"},"updated_at":{"description":"Date and time the payout config was last updated at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"409":{"$ref":"#/paths/~1v1~1payouts/post/responses/409"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payout_configs/{payout_config_id}":{"get":{"operationId":"get_payout_config","summary":"Get payout config","description":"Get payout config details by the payout config ID.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"in":"path","required":true,"name":"payout_config_id","schema":{"type":"string"},"description":"The unique payout config identifier.\n\nPrefix is \"pyc\" in production and \"sbx_pyc\" in sandbox.","examples":{"production":{"value":"pyc_33F8uybrmDPypCLAmKYsC30YKaN"},"sandbox":{"value":"sbx_pyc_33F8uybrmDPypCLAmKYsC30YKaN"}}},{"name":"allowed_rails","in":"query","description":"One or more payout rails to narrow the rails returned in `payout_fees`. Provide parameter multiple times to filter by multiple rails. When omitted, all of the merchant's allowed payout rails are returned.","schema":{"type":"array","items":{"description":"The rail used to send the payout.\n\nCurrently, only `ACH` is supported.","type":"string","example":"ACH","enum":["ACH"]}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/payout_configs/{payout_config_id}/payout_timing":{"get":{"operationId":"get_payout_timing","summary":"Get payout timing","description":"Preview the dates a payout would be scheduled for.\n\nThis endpoint requires the platform to be approved for the Payouts integration.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1payout_configs~1{payout_config_id}/get/parameters/1","in":"path"},{"name":"requested_payout_date","in":"query","description":"The requested date to process the payout, in ISO 8601 format (YYYY-MM-DD). The payout will be scheduled to process on the next available date relative to the requested date. When omitted, the earliest available date is previewed.","schema":{"type":"string","format":"date"},"example":"2022-01-01"},{"name":"rail","in":"query","description":"The payout rail.","schema":{"$ref":"#/paths/~1v1~1payout_configs~1{payout_config_id}/get/parameters/2/schema/items","default":"ACH"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"rail":{"$ref":"#/paths/~1v1~1payout_configs~1{payout_config_id}/get/parameters/2/schema/items"},"requested_payout_date":{"description":"The requested date to process the payout, in ISO 8601 format (YYYY-MM-DD). The payout will be scheduled to process on the next available date relative to the requested date. When omitted, the earliest available date is previewed.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date","nullable":true},"scheduled_payout_date":{"description":"The date the payout is scheduled to process on.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date"},"estimated_arrival_date":{"description":"The estimated date the payout funds will arrive in the payout receiver's bank account.","$ref":"#/paths/~1v1~1top_up_quotes/get/responses/200/content/application~1json/schema/properties/data/properties/debit_date"}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payouts"]}},"/v1/merchants/{merchant_id}/payout_receivers":{"post":{"operationId":"create_payout_receiver","summary":"Create payout receiver","description":"Create a payout receiver for a merchant. Payout receivers can receive payouts from a merchant's available balance.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request to create a payout receiver for a merchant. A `MERCHANT`-type payout receiver is the merchant itself and advances straight to `ACTIVE`.","type":"object","properties":{"type":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/2/schema/items"},"name":{"description":"The payout receiver's display name.","type":"string"},"legal_name":{"description":"The receiver's legal registered business name. Only applicable for type `EXTERNAL_BUSINESS`. For type MERCHANT, the legal name will be populated by the merchant's data.","type":"string"},"first_name":{"description":"The receiver's first name. Only applicable for type `EXTERNAL_INDIVIDUAL`. For type `MERCHANT`, the first name will be populated by the merchant's data if the merchant type is `INDIVIDUAL`.","type":"string"},"last_name":{"description":"The receiver's last name. Only applicable for `EXTERNAL_INDIVIDUAL`. For type `MERCHANT`, the last name will be populated by the merchant's data if the merchant type is `INDIVIDUAL`.","type":"string"},"default_payout_category":{"description":"The default category to set on a payout.","type":"string","enum":["ACCOUNTS_PAYABLE","CONTRACTOR","LEASE_AND_PROPERTY","UTILITIES","OWN_ACCOUNT","OTHER"],"example":"ACCOUNTS_PAYABLE"},"metadata":{"description":"Valid JSON key-value object specified by the platform to store additional information on the receiver. Do not use the metadata field to store sensitive or confidential data.\n\nMetadata must be less than 8 KB in size.\n","type":"object","example":{"key1":"value1","key2":{"inner_key1":"inner_value1"}},"minLength":0}},"required":["type","name"]},"examples":{"self_onboarding":{"value":{"type":"MERCHANT","name":"Acme Inc."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"payout_receiver_id":{"description":"The unique payout receiver identifier.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","type":"string","example":"rcv_2DrDFJPutxE5AIbJSopAnqniEbr"},"platform_id":{"description":"The unique platform identifier. \n\nPrefix is \"plt\" in production and \"sbx_plt\" in sandbox.","type":"string","example":"plt_2DrDypu8n6IX7EVTjAnEd1dkTBa"},"merchant_id":{"$ref":"#/paths/~1v1~1payin_configs~1top_up/post/requestBody/content/application~1json/schema/properties/merchant_id"},"type":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/2/schema/items"},"name":{"description":"The friendly display name for the payout receiver.","type":"string"},"legal_name":{"description":"The payout receiver's legal registered business name. Only set for type `EXTERNAL_BUSINESS`.","type":"string","nullable":true},"first_name":{"description":"The payout receiver's first name. Only set for type `EXTERNAL_INDIVIDUAL`.","type":"string","nullable":true},"last_name":{"description":"The payout receiver's last name. Only set for type `EXTERNAL_INDIVIDUAL`.","type":"string","nullable":true},"default_payout_category":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/default_payout_category","nullable":true},"status":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/3/schema/items"},"payout_receiver_payment_methods":{"description":"The payout receiver's payment methods to send the payout to.","type":"array","items":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data"}},"metadata":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/metadata"},"paid_ytd":{"description":"The amount paid out to the payout receiver since January 1 UTC.","type":"object","properties":{"amount":{"description":"The amount paid, in minor units.\n\nFor example, 1000 is 10.00 USD.","type":"integer"},"currency_code":{"$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/5/schema"}}},"total_payouts":{"description":"The number of payouts made to the payout receiver.","type":"integer"},"created_at":{"description":"Date and time the payout receiver was created at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at"},"updated_at":{"description":"Date and time the payout receiver was last updated at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true},"deactivated_by":{"description":"Who deactivated the payout receiver.","nullable":true,"type":"string","enum":["MERCHANT","PLATFORM","RAINFOREST"],"example":"PLATFORM"}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]},"get":{"operationId":"list_merchant_payout_receivers","summary":"List merchant payout receivers","description":"Query a list of a merchant's payout receivers with optional search criteria.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"in":"path","required":true,"name":"merchant_id","schema":{"type":"string"},"description":"The unique merchant identifier. \n\nPrefix is \"mid\" in production and \"sbx_mid\" in sandbox.","examples":{"production":{"value":"mid_2DrDFJPutxE5AIbJSopAnqniEbr"},"sandbox":{"value":"sbx_mid_2DrDFJPutxE5AIbJSopAnqniEbr"}}},{"name":"type","in":"query","description":"One or more payout receiver types to filter by. Provide parameter multiple times to filter by multiple payout receiver types.","schema":{"type":"array","items":{"description":"The type of payout receiver.","type":"string","enum":["MERCHANT","EXTERNAL_BUSINESS","EXTERNAL_INDIVIDUAL"],"example":"EXTERNAL_BUSINESS"}}},{"name":"status","in":"query","description":"One or more payout receiver statuses to filter by. Provide parameter multiple times to filter by multiple statuses.","schema":{"type":"array","items":{"description":"The status of the payout receiver.","type":"string","enum":["NEEDS_INFORMATION","VERIFYING","NEEDS_METHOD","ACTIVE","DECLINED","DEACTIVATED"],"example":"ACTIVE"}}},{"name":"sort_by","in":"query","description":"Optional value by which to sort the result set. Default sort by is created_at.","schema":{"type":"string","enum":["created_at"]}},{"$ref":"#/paths/~1v1~1payouts/get/parameters/9","in":"query"},{"$ref":"#/paths/~1v1~1payouts/get/parameters/10","in":"query"},{"$ref":"#/paths/~1v1~1payouts/get/parameters/11","in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"allOf":[{"type":"object","properties":{"last_key":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/data/properties/last_key"}}},{"type":"object","properties":{"results":{"description":"List of payout receivers.","type":"array","items":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"}}}}]},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}":{"get":{"operationId":"get_merchant_payout_receiver","summary":"Get merchant payout receiver","description":"Get a merchant's payout receiver by the payout receiver ID.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"in":"path","required":true,"name":"payout_receiver_id","schema":{"type":"string"},"description":"The unique payout receiver identifier.\n\nPrefix is \"rcv\" in production and \"sbx_rcv\" in sandbox.","examples":{"production":{"value":"rcv_2DrDFJPutxE5AIbJSopAnqniEbr"},"sandbox":{"value":"sbx_rcv_2DrDFJPutxE5AIbJSopAnqniEbr"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]},"patch":{"operationId":"update_payout_receiver","summary":"Update payout receiver","description":"Update a payout receiver. Only the fields included in the payload will be updated. Omitted fields will not be updated. To remove a field, set the value to `null`.\n\nThe following fields can be updated when the payout receiver is in the status of `NEEDS_INFORMATION`: `legal_name`, `first_name`, and `last_name`\n\nThe following fields can be updated when the payout receiver is any status except `DECLINED` and `DEACTIVATED`: `name`, `default_payout_category`, and `metadata`","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Request to update a payout receiver. Only the fields provided are changed.","type":"object","properties":{"name":{"description":"The payout receiver's display name. Cannot be blank.","type":"string"},"legal_name":{"description":"The payout receiver's legal registered business name. Only applicable for type `EXTERNAL_BUSINESS`.","type":"string"},"first_name":{"description":"The payout receiver's first name. Only applicable for type `EXTERNAL_INDIVIDUAL`.","type":"string"},"last_name":{"description":"The receiver's last name. Only applicable for type `EXTERNAL_INDIVIDUAL`.","type":"string"},"default_payout_category":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/default_payout_category"},"metadata":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/requestBody/content/application~1json/schema/properties/metadata","description":"Valid JSON key-value object specified by the platform to store additional information. Do not use the metadata field to store sensitive or confidential data.\n\nUpdating metadata will merge with the existing metadata stored on the payout receiver by the top-level key. If the same top-level key is passed in this request, it will overwrite the value stored on the payout receiver. Only keys included in the payload will be updated. To remove a key, set the key's value to `null`.\n\nMetadata must be less than 8 KB in size."}}},"examples":{"rename":{"value":{"name":"Acme Supplies"}},"external_individual":{"value":{"first_name":"Jane","last_name":"Doe","default_payout_category":"CONTRACTOR"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}/submit":{"post":{"operationId":"submit_payout_receiver","summary":"Submit payout receiver","description":"Submit a payout receiver for verification. The payout receiver status must be `NEEDS_INFORMATION`.\n\nSubmitting also verifies the payout receiver’s payment methods. If at least one payment method is verified, then the receiver moves to the status of `ACTIVE` and the earliest added verified method becomes the payout receiver's default payment method.\n\nIf the payout receiver has no payment method that can be verified, it moves to the status of `NEEDS_METHOD`. Add and verify a payment method to activate the receiver.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}/deactivate":{"post":{"operationId":"deactivate_payout_receiver","summary":"Deactivate payout receiver","description":"Permanently deactivate a payout receiver. A deactivated receiver cannot receive payouts. The payout receiver status must be `NEEDS_INFORMATION`, `NEEDS_METHOD`, or `ACTIVE` to be deactivated.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"Why the payout receiver is being deactivated.","type":"string"}}},"examples":{"with_reason":{"value":{"reason":"Vendor relationship ended"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}/simulate":{"post":{"operationId":"simulate_payout_receiver","summary":"Simulate payout receiver status change","description":"Only available in the Rainforest sandbox environment. Simulate a payout receiver status change from `VERIFYING` to `ACTIVE`, `NEEDS_METHOD`, or `DECLINED`. The expected webhooks will be sent for the payout receiver on each status change.\n\nSimulating to `NEEDS_METHOD` deactivates the payout receiver's payment methods.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Simulation request for transitioning payout receiver status.","type":"object","properties":{"status":{"description":"Status to transition the `VERIFYING` payout receiver to.\n\n* `ACTIVE` verifies any `CREATED` payout receiver payment methods and activates the payout receiver. Returns a 400 if it has no usable payout method.\n* `NEEDS_METHOD` deactivates the payout receiver's payout receiver payment methods, so a new one must be added and verified.\n* `DECLINED` declines the payout receiver, with an optional `reason`.","type":"string","enum":["ACTIVE","NEEDS_METHOD","DECLINED"],"example":"ACTIVE"},"reason":{"description":"The reason the payout receiver was declined. Only valid when status is `DECLINED`.","type":"string","maxLength":255,"example":"Identity could not be verified"}},"required":["status"]},"examples":{"active":{"value":{"status":"ACTIVE"}},"needs_method":{"value":{"status":"NEEDS_METHOD"}},"declined":{"value":{"status":"DECLINED","reason":"Identity could not be verified"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}/payout_receiver_payment_method":{"post":{"operationId":"create_payout_method","summary":"Onboard payout receiver payout method","description":"Add a payment method to a payout receiver. The payment method must have the `PAYOUT` capability. A payout receiver payment method will be created to associate a payout receiver with a payment method. The payout receiver payment method status will be `CREATED` and will move to `ACTIVE` once the payout receiver is submitted and the payment method is verified.\n\nThe payout receiver status must be `NEEDS_INFORMATION`, `NEEDS_METHOD` or `ACTIVE`.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"payment_method_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/payment_method_id","description":"The unique payment method identifier to link to the payout receiver. Must have the `PAYOUT` capability. Required unless the payout receiver represents the merchant itself.\n\nPrefix is \"mtd\" in production and \"sbx_mtd\" in sandbox."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"type":"object","properties":{"payout_receiver_payment_method_id":{"$ref":"#/paths/~1v1~1payouts/post/requestBody/content/application~1json/schema/properties/payout_receiver_payment_method_id"},"payout_receiver_id":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/post/responses/200/content/application~1json/schema/properties/data/properties/payout_receiver_id"},"payment_method_id":{"description":"The unique payment method identifier. \n\nPrefix is \"mtd\" in production and \"sbx_mtd\" in sandbox.","type":"string","example":"mtd_2DrDRpyAdp5MPUJnrJmoZcMmtfF"},"is_default":{"description":"Boolean indicating if the payment method is the default method for the payout receiver's payouts. Payment method status must be `ACTIVE`.","type":"boolean"},"status":{"description":"The status of the payout receiver payment method.","type":"string","enum":["CREATED","PENDING","ACTIVE","DEACTIVATED"],"example":"ACTIVE"},"method_type":{"description":"The type of the payment method.","$ref":"#/paths/~1v1~1top_up_quotes/get/parameters/3/schema"},"ach":{"description":"ACH payment method details.","type":"object","properties":{"account_number_last_4":{"description":"The last 4 digits of the account number.","type":"string","example":"5678"},"routing_number":{"description":"The 9-digit routing number.","type":"string","example":"091000019","maxLength":9,"minLength":9},"bank_name":{"description":"The bank name.","type":"string","example":"Wells Fargo Bank"},"account_type":{"description":"The account type. Defaulted to CHECKING if omitted.","type":"string","example":"CHECKING","enum":["CHECKING","SAVINGS"]},"account_holder_type":{"description":"The account holder type.","type":"string","example":"PERSONAL","enum":["PERSONAL","BUSINESS"]}}},"plaid_ach":{"description":"ACH payment method details from Plaid.","type":"object","properties":{"account_number_last_4":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/ach/properties/account_number_last_4"},"routing_number":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/ach/properties/routing_number"},"bank_name":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/ach/properties/bank_name"},"account_type":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/ach/properties/account_type"},"account_holder_type":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data/properties/ach/properties/account_holder_type"}}},"created_at":{"description":"Date and time the payout receiver payment method was created at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at"},"updated_at":{"description":"Date and time the payout receiver payment method was last updated at in UTC RFC 3339 format.","$ref":"#/paths/~1v1~1payout_configs/post/responses/200/content/application~1json/schema/properties/data/properties/created_at","nullable":true}}},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}},"/v1/merchants/{merchant_id}/payout_receivers/{payout_receiver_id}/payment_methods/{payout_receiver_payment_method_id}/verify":{"post":{"operationId":"verify_payout_receiver_payment_method","summary":"Verify payout receiver payout method","description":"Verify a payout receiver payment method that is in the status of `NEEDS_METHOD` or `ACTIVE`.\n\nFor a payout receiver in the status of `NEEDS_INFORMATION`, submit the payout receiver to verify the receiver's payment methods.\n\nIf the method is verified, then the payout receiver payment method's status will move to `ACTIVE`. A payout receiver in the status of `NEEDS_METHOD` will move to `ACTIVE`.","parameters":[{"$ref":"#/paths/~1v1~1payouts/get/parameters/0"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers/get/parameters/1","in":"path"},{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}/get/parameters/2","in":"path"},{"in":"path","required":true,"name":"payout_receiver_payment_method_id","schema":{"type":"string"},"description":"The unique payout receiver payment method identifier that associates the payout receiver to the payment method.\n\nPrefix is \"rpm\" in production and \"sbx_rpm\" in sandbox.","examples":{"production":{"value":"rpm_2DrDRpyAdp5MPUJnrJmoZcMmtfF"},"sandbox":{"value":"sbx_rpm_2DrDRpyAdp5MPUJnrJmoZcMmtfF"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"properties":{"status":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/status"},"data":{"$ref":"#/paths/~1v1~1merchants~1{merchant_id}~1payout_receivers~1{payout_receiver_id}~1payout_receiver_payment_method/post/responses/200/content/application~1json/schema/properties/data"},"errors":{"$ref":"#/paths/~1v1~1payouts/get/responses/200/content/application~1json/schema/properties/errors"}}}}}},"400":{"$ref":"#/paths/~1v1~1payouts/get/responses/400"},"401":{"$ref":"#/paths/~1v1~1payouts/get/responses/401"},"403":{"$ref":"#/paths/~1v1~1payouts/get/responses/403"},"404":{"$ref":"#/paths/~1v1~1payouts/post/responses/404"},"5XX":{"$ref":"#/paths/~1v1~1payouts/get/responses/5XX"}},"tags":["Payout Receivers"]}}},"tags":[{"name":"Payouts","description":"Resources for payout functions."},{"name":"Payout Receivers","description":"Resources for payout receiver functions."}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"APIKey"}}},"security":[{"BearerAuth":[]}]}