Simulate a transaction
Allows you to simulate a transaction of a specific type, useful for generating data in sandbox environment and therefore use transaction payloads before going into production.
- Card Authorization : Simulates a transaction authorization on the given card.
- Card Clearing : Simulates the clearing of the previous authorization using its transaction id.
- Credit Ledger : Simulates a transaction to the given ledger. The amount can contain 2 decimal places and the maximum is 1000.
OK
Bad Request
Unauthorized
Forbidden
Conflict
- Payload
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
{- "amount": 0,
- "cardId": "f16ba382-eb42-481a-b08f-c57bdc9aae24",
- "merchantName": "string",
- "merchantCity": "string",
- "merchantCountry": "string",
- "merchantId": "string",
- "merchantCategoryCode": "string"
}- 400
- 401
- 403
- 409
{- "details": [
- {
- "field": "{path.to.field}",
- "rejectedValue": "{rejectedValue}",
- "message": "Ledger with id {0} was not found."
}
], - "errorCode": "LEDGER_NOT_FOUND",
- "error": "linkcy.bad.request",
- "status": 400,
- "timestamp": "2024-11-14T16:15:00.530068028Z"
}Initialize or reset a password with secret in response
Whether you want to initialize first password or reset a password, you should use this endpoint. Send a secret in response that can be used to change the password of the account.
OK
Bad Request
Unauthorized
Forbidden
- Payload
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
{- "consumerPhone": "33123456789",
- "partnerName": "string",
- "phone": "string"
}- 200
- 400
- 401
- 403
{- "passwordChangeSecret": "string"
}Credit a ledgerDeprecated
Use POST /api/partner/transactions/simulate instead !
Used to simulate an external credit to a ledger, http errors are not yet handled/no validation. The amount can contain 2 decimal places and the maximum is 1000.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
- Payload
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
{- "amount": 0,
- "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
- "reference": "string"
}- 400
- 401
- 403
- 404
- 409
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}Simulate a KYC result for a consumer or a corporate-related person
Simulate a KYC for a consumer or corporate related person with custom values.
The missing information will be automatically populated with default values.
Request Body schema: application/jsonrequired
Simulated KYC successfully created
Bad Request
Unauthorized
Forbidden
- Payload
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
{- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
- "kycStatus": "NOT_STARTED",
- "address": {
- "isoCountryCode": "AUT",
- "city": "string",
- "postalCode": "string",
- "street": "string",
- "number": "string",
- "refinement": "string",
- "stateOrProvince": "string",
- "bypassVerification": true
}, - "firstName": "string",
- "middleName": "string",
- "lastName": "string",
- "gender": "MALE",
- "birthDate": "2019-08-24",
- "emailAddress": "string",
- "birthCity": "string",
- "birthIsoCountryCode": "ABW",
- "nationalityCode": "ABW"
}- 201
- 400
- 401
- 403
{- "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65",
- "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}Delete a corporate
Delete a corporate by id. This endpoint allows you to try again the whole corporate creation flow.
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
- 400
- 401
- 403
- 404
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}Manually bypass a corporate's KYB status
Used to update manually the KYB status of a corporate in order to try different use cases.
Request Body schema: application/jsonrequired
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
- Payload
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
{- "kybStatus": "NOT_STARTED",
- "bypassCompliance": true
}- 200
- 400
- 401
- 403
- 404
- 409
{- "corporateId": "50eb73c4-9d2f-4e30-9f0c-2d57c30a46ee"
}Delete a consumer
Delete a consumer by id. This endpoint allows you to try again the whole consumer creation flow.
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
- 400
- 401
- 403
- 404
{- "status": 400,
- "details": [
- {
- "field": "name",
- "rejectedValue": "John Doe 56",
- "message": "Name must contains only letters"
}
], - "error": "linkcy.bad.request",
- "timestamp": "2019-08-24T14:15:22Z"
}Bypass a beneficiary's status
Allows you to manually set a beneficiary's status to VALID, useful for bypassing the current status if it was PENDING_REVIEW or DECLINED.
OK
Bad Request
Unauthorized
Forbidden
Not Found
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
- 200
- 400
- 401
- 403
- 404
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Get a card truncated PAN
Used to get the truncated PAN of a card (that you will not receive) in order to activate it.
OK
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
- curl
- Java
- JavaScript
- Python
- Node.js
- C#
- 200
- 400
- 401
- 403
- 404
- 409
"string"