Get Settlement details
GET https://{domainname}/v1/{merchantId}/services/settlementdetails/{paymentId}
Services
Under services you find several calls that can be used to support your payment flow:
- Test your connection to us
- Convert an amount from one currency to another
- Convert between different bank account notations
- Retrieve the card type and country where the card was issued based on the IIN of the card
- Retrieve the ARN (Acquirer Reference Number), RRN (Retrieval Reference Number), Amount and Currency for a payment
Request
Using the settlement details API you can retrieve the ARN (Acquirer Reference Number), RRN (Retrieval Reference Number), Amount and Currency for a payment using the paymentId.
Request example
SDK: Ruby
This scenario you will probably use the most
-
response = client.merchant('merchantId').services.settlementdetails('paymentId')
Responses
Please find below an overview of the possible responses.
Response 200 - OKSettlementDetails
The response contains the settlement details
|
Properties
|
|||
| Property | Type | Required | Details |
|---|---|---|---|
| acquirerReferenceNumber | string | no | read close |
|
close
DescriptionThe Acquirer Reference Number (ARN) is a unique identifier assigned to a card payment as it moves through the payment network.
|
|||
| object | no | read close | |
| 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
|
|||
| paymentId | string | no | read close |
|
close
DescriptionOur unique payment transaction identifier.
|
|||
| retrievalReferenceNumber | string | no | read close |
|
close
DescriptionThe Retrieval Reference Number (RRN) provides a unique reference for a card payment, pinpointing it to a specific date.
|
|||
Response example
SDK: Ruby
This scenario you will probably use the most
-
{ "acquirerReferenceNumber" : "10028", "amountOfMoney" : { "amount" : 100, "currencyCode" : "EUR" }, "paymentId" : "000000850010000188180000200001", "retrievalReferenceNumber" : "10029" }
Response 400 - Bad requestErrorResponse
|
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" : "64ak532548e16b774eaf67742cee318b", "errors" : [ { "code" : "1801", "id" : "UNSUPPORTED_OGONE_PAYMENT_PLATFORM_OPERATION", "category" : "CONNECT_PLATFORM_ERROR", "message" : "The requested method is not available for the Ogone payment platform", "httpStatusCode" : 400 } ] }
Response 404 - Not foundErrorResponse
settlement details not found
|
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" : "61bc532548e16b774eaf67742cee359b", "errors" : [ { "code" : "1902", "id" : "SETTLEMENT_DETAILS_NOT_FOUND", "category" : "CONNECT_PLATFORM_ERROR", "message" : "SETTLEMENT_DETAILS_NOT_FOUND", "httpStatusCode" : 404 } ] }