Find payouts
GET https://{domainname}/v1/{merchantId}/payouts
Payouts
Our payout service allows you to easily transfer money directly, either to a card or into a bank account of your choice.
Before we can process your payout request you will need to pre-fund the total amount of money you want to payout.
For more information about card payouts please click here or for more information about bank payouts please click here.
Request
Retrieves the details of payouts based on your order identifier, your unique transaction reference, or both.
In addition to the filter, you can also provide an offset and limit. In combination with the total number of payouts matching the filter that is part of the response, this allows you to implement paging.
Query parameters
Query parameters for this method
| Property | Type | Required | Repeat | Details |
|---|---|---|---|---|
| merchantReference | string | no | no | read close |
|
close
DescriptionYour unique transaction reference to filter on.
|
||||
| merchantOrderId | integer | no | no | read close |
|
close
DescriptionYour order identifier to filter on.
|
||||
| offset | integer | no | no | read close |
|
close
DescriptionThe zero-based index of the first payout in the result. If omitted, the offset will be 0.
|
||||
| limit | integer | no | no | read close |
|
close
DescriptionThe maximum number of payouts to return, with a maximum of 100. If omitted, the limit will be 10.
|
||||
Request example
SDK: Ruby
This scenario you will probably use the most
-
query = Payouts::FindPayoutsParams.new query.merchant_reference = 'AcmeOrder0001' query.merchant_order_id = 123456 query.offset = 0 query.limit = 10 response = client.v1.merchant('merchantId').payouts.find(query)
Responses
Please find below an overview of the possible responses.
Response 200 - OKFindPayoutsResponse
The response contains an array of payouts that match the filters supplied in the request.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| limit | integer | no | read close |
|
close
DescriptionThe limit you used in the request.
|
|||
| offset | integer | no | read close |
|
close
DescriptionThe offset you used in the request.
|
|||
| array of object | no | read close | |
|
close
DescriptionA list of payouts that matched your filter, starting at the given offset and limited to the given limit.
|
|||
| object | no | read close | |
| id | string | no | read close |
|
close
DescriptionOur unique payout transaction identifier
|
|||
| object | no | read close | |
| object | no | read close | |
|
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
| amount | integer (12) | yes | read close |
|
close
DescriptionAmount in cents and always having 2 decimals
|
|||
| currencyCode | string (3) | yes | read close |
|
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
| object | no | read close | |
|
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
| merchantOrderId | integer | no | read close |
|
close
DescriptionYour order ID for this transaction that is also returned in our report files
|
|||
| merchantReference | string | no | read close |
|
close
DescriptionYour unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
|
|||
| paymentReference | string | no | read close |
|
close
DescriptionPayment Reference generated by WebCollect
|
|||
| providerId | string | no | read close |
|
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
| providerMerchantId | string | no | read close |
|
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
| providerReference | string | no | read close |
|
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
| referenceOrigPayment | string | no | read close |
|
close
DescriptionWhen you did not supply a merchantReference for your payment, you need to fill this property with the reference of the original payment when you want to refund it
|
|||
| status | enum | no | read close |
|
close
DescriptionCurrent high-level status of the payouts in a human-readable form. Possible values are :
Please see Statuses for a full overview of possible values. |
|||
| object | no | read close | |
|
close
DescriptionThis object has the numeric representation of the current payout status, timestamp of last status change and performable action on the current payout resource.
In case of a rejected payout, detailed error information is listed.
|
|||
| array of object | no | read close | |
|
close
DescriptionCustom object contains the set of errors
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
| propertyName | string | no | read close |
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
| isCancellable | boolean | no | read close |
|
close
DescriptionFlag indicating if the payment can be cancelled
|
|||
| isRetriable | boolean | no | read close |
|
close
DescriptionFlag indicating whether a rejected payment may be retried by the merchant without incurring a fee
|
|||
| array of object | no | read close | |
|
close
DescriptionThis is the raw response returned by the acquirer. This property contains unprocessed data directly returned by the acquirer. It's recommended for data analysis only due to its dynamic nature, which may undergo future changes.
|
|||
| object | no | read close | |
| key | string | no | read close |
|
close
DescriptionName of the key or property
|
|||
| value | string | no | read close |
|
close
DescriptionValue of the key or property
|
|||
| statusCategory | enum | no | read close |
|
close
DescriptionHighlevel status of the payment, payout or refund with the following possible values:
Please see Statuses for a full overview of possible values. |
|||
| statusCode | integer | no | read close |
|
close
DescriptionNumeric status code of the legacy API. It is returned to ease the migration from the legacy APIs to Worldline Connect. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the GlobalCollect Payment Console, in the Ogone BackOffice and in report files.
|
|||
| statusCodeChangeDateTime | string | no | read close |
|
close
DescriptionDate and time of payment
Format: YYYYMMDDHH24MISS |
|||
| totalCount | integer | no | read close |
|
close
DescriptionThe total number of payouts that matched your filter.
|
|||
Response example
SDK: Ruby
This scenario you will probably use the most
-
{ "payouts" : [ { "id" : "00000088970000001521000-100001", "payoutOutput" : { "amountOfMoney" : { "amount" : 2345, "currencyCode" : "EUR" }, "references" : { "merchantOrderId" : 123456, "merchantReference" : "AcmeOrder001", "paymentReference" : "0" } }, "status" : "CANCELLED", "statusOutput" : { "isCancellable" : false, "statusCode" : 9999, "statusCodeChangeDateTime" : "20140707093101" } } ], "offset" : 0, "limit" : 10, "totalCount" : 1 }
Response 400 - Bad requestErrorResponse
You did not provide a valid filter, your offset or limit is negative, or your limit is too high.
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| errorId | string | yes | read close |
|
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
| array of object | yes | read close | |
|
close
DescriptionList of one or more errors
|
|||
| object | no | read close | |
| category | string | no | read close |
|
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
| code | string | yes | read close |
|
close
DescriptionError code
|
|||
| httpStatusCode | integer | no | read close |
|
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
| id | string | no | read close |
|
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
| message | string | no | read close |
|
close
DescriptionHuman-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
|
|||
| propertyName | string | no | read close |
|
close
DescriptionReturned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query. Some common examples:
|
|||
| requestId | string | no | read close |
|
close
DescriptionID of the request that can be used for debugging purposes
|
|||
Response example
SDK: Ruby
This scenario you will probably use the most
-
{ "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092", "errors" : [ { "code" : "20000000", "propertyName" : "bankAccountBban.accountNumber", "message" : "PARAMETER_NOT_FOUND_IN_REQUEST" } ] }