Centtrip API (v1)

Download OpenAPI specification:Download

Centtrip Public API: tech@centtrip.com Terms of Service

API for Centtrip Ltd

Account

Get accounts

Get accounts to which you have access to

Authorizations:

OAuth2

query Parameters

pageSize	integer <int32> Example: pageSize=10 Page size
cursor	string Example: cursor=8de298de-6ba6-44c7-b00f-529672f2f522 Cursor to get the next or previous page

Responses

Response samples

200

Content type

application/json

{"next": "https://api.centtrip.com/api/v2/accounts?cursor=ee8bc5a4b0b141ad924d65112fd0a17f",
"value": [{"id": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--b91e5055-25b1-4376-bee6-aaac6fa5f2f5",
"name": "Corporate 12345"
},
{"id": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--c413f3b6-c0ee-486d-9fac-031f2a6be886",
"name": "Corporate 54321"
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get account balance

Get balances associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"currency": "USD",
"amount": 6637.42
},
{"currency": "CAD",
"amount": 6466.08
},
{"currency": "EUR",
"amount": 10113.03
},
{"currency": "GBP",
"amount": 23246.16
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get account transactions

Get transactions associated with an account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

query Parameters

startDateTime	string or null <date-time>
endDateTime	string or null <date-time>
currency	string or null
pageSize	integer or null <int32>
prevDateTime	string or null <date-time>
nextDateTime	string or null <date-time>
excludedRefIds	Array of strings or null <uuid>

Responses

Response samples

200

Content type

application/json

{"next": "/api/v1/accounts/5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1/transactions?pageSize=25&nextDateTime=2021-12-20T10%3A28%3A28.7256990Z&excludedRefIds=281456bc-766d-4ab6-bc13-4d59cbc3298b",
"value": [{"id": "306149db-5f46-483b-9a3d-fa32993f9748",
"dateTime": "2022-09-20T13:39:31.137087Z",
"description": "Centtrip Invoice - CENT11111",
"currency": "GBP",
"amount": -10.12,
"balance": 23246.16,
"transactionType": "FromAccountToAccount",
"type": "Account",
"labels": ["Label123"
],
"documentCount": 1
},
{"id": "1258aa5b-67dc-4ebe-8600-9178bb292e7f",
"dateTime": "2022-08-24T13:23:15.062334Z",
"description": "Payment to bank - Thomas Falkner|Reference - asdf",
"currency": "EUR",
"amount": -1111.13,
"balance": 10113.03,
"transactionType": "FromAccountToBank",
"type": "Payment",
"labels": null,
"documentCount": 0
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get account transaction documents

Get documents associated with the account transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
transactionId required	string <uuid> Example: 306149db-5f46-483b-9a3d-fa32993f9748 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"id": "e5d9b0b1-7449-4254-8461-84366c71352d",
"parentRefId": "306149db-5f46-483b-9a3d-fa32993f9748",
"startDateTime": "2022-09-29T11:00:54.564259",
"endDateTime": null,
"clientRefId": "b27573b6-49af-41c7-ba1b-424d2aeb6020",
"action": "Insert",
"type": "Document",
"value": "Receipt - 17_03_2022 05_44image_jpeg.jpg",
"text": "462cb9be-2f11-46b7-8020-73453e5096c2"
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get account transaction document

Get document details associated with the account transaction. The URL for the document is only valid for 5 minutes.

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
transactionId required	string <uuid> Example: 306149db-5f46-483b-9a3d-fa32993f9748 Transaction Identifier
documentId required	string <uuid> Example: e5d9b0b1-7449-4254-8461-84366c71352d Document Identifier

Responses

Response samples

200

Content type

application/json

{"value": {"id": "462cb9be-2f11-46b7-8020-73453e5096c2",
"entityRefId": "306149db-5f46-483b-9a3d-fa32993f9748",
"url": "https://www.centtrip.com/documents/000f42bf-0000-0000-0000-000000000000/462cb9be-2f11-46b7-8020-73453e5096c2/Document?Expires=1664450163&Key-Pair-Id=APKAIPH2FJESQQ2HRTBQ&Signature=Y~cjkJEECR7T5WNBVSb-PJtYZOLBloL6AOkZcmS~mn8KHRKF25AhidYx~-CZawUkhSnUk5A1BGqtUE9KHG3ExqlUHylpkSwDQ-Xm9t0UXMQaIz-slzH4bTGhkEHBdKI2WzK~MB9sq3-mJEBO8prTPO83iJsj1D48jojP5M5z2IRMJvJppjaUruVHup-Us2VkP0D~zrGLjrMKaG6u5KuWF~sYrxVtN1d71Inp17wqyWaJ83JOq0zNjW9hPeHAoWQl~eAv9VomqzvCaLUefvXwn1U6BlMEOv0yPq3R9qSVLdclf4NQF5p~XHSdfrIn~nsjqB9lX20tvA6~jl4uImpAVg__",
"status": "Clean",
"filename": "Receipt - 17_03_2022 05_44image_jpeg.jpg"
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Add account transaction references

Add multiple references to an account transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

journalRefIds	Array of strings or null <uuid>
reference	string or null

Responses

Request samples

Payload

Content type

application/json

{"journalRefIds": ["306149db-5f46-483b-9a3d-fa32993f9748"
],
"reference": "MyReference"
}

Response samples

200
400

Content type

application/json

{"value": [{"value": {"parentRefId": "306149db-5f46-483b-9a3d-fa32993f9748",
"startDateTime": "2022-09-29T11:20:20.3773775Z",
"endDateTime": null,
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"refId": "69b21cbf-15c7-4afe-ac25-d6d1dcfb89fe",
"action": "Insert",
"type": "Reference",
"value": "MyReference",
"text": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get account transaction references

Get references associated with the account transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
transactionId required	string <uuid> Example: 306149db-5f46-483b-9a3d-fa32993f9748 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"id": "69b21cbf-15c7-4afe-ac25-d6d1dcfb89fe",
"parentRefId": "306149db-5f46-483b-9a3d-fa32993f9748",
"startDateTime": "2022-09-29T11:20:20.377377",
"endDateTime": null,
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"action": "Insert",
"type": "Reference",
"value": "MyReference",
"text": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Delete account transaction references

Delete references associated with account transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
transactionId required	string <uuid> Example: 306149db-5f46-483b-9a3d-fa32993f9748 Transaction Identifier

Request Body schema: application/json

reference

string or null

Responses

Request samples

Payload

Content type

application/json

{"reference": "MyReference"
}

Response samples

200
404

Content type

application/json

{"value": {"parentRefId": null,
"startDateTime": "2022-09-29T11:27:00.4847658Z",
"endDateTime": "2022-09-29T11:27:00.4847658Z",
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"refId": "d41d9693-df48-489c-b130-74c737aef29b",
"action": "Delete",
"type": "Reference",
"value": "MyReference",
"text": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transactions

Get all card transactions associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

query Parameters

startDateTime	string <date-time>
endDateTime	string <date-time>
currency	string
pageSize	integer <int32>
prevDateTime	string <date-time>
nextDateTime	string <date-time>
excludedRefIds	Array of strings <uuid>
hasDocument	boolean
reference	string
referenceOperator	string (QueryOperator) Enum: "None" "HasValue" "HasNoValue" "EqualTo" "DoesNotContain"

Responses

Response samples

200

Content type

application/json

{"next": "/api/v1/accounts/5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1/cardTransactions?pageSize=100&nextDateTime=2020-07-10T09%3A45%3A15.5473160Z&excludedRefIds=9e8e1a88-c0a7-4e9d-88a9-05534703150d",
"value": [{"cardId": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--eccf37ca-1ded-4f30-bfa3-10fcac3e41a0",
"id": "f824ae9e-8640-48e0-b833-b8284ced4938",
"entryDateTime": "2022-01-21T09:16:29.443636Z",
"utcTransactionDateTime": "2022-01-21T10:45:15.547398Z",
"localTransactionDateTime": "2022-01-21T05:39:15",
"cardTransactionType": "AtmWithdrawal",
"responseCode": "000",
"responseDescription": "Approved",
"authNumber": "895999",
"description": "ATM Withdrawal",
"mcc": "6011",
"merchantCategory": null,
"terminalCountry": "IT",
"terminalState": "ITA",
"terminalCity": "BUDONI",
"terminalLocation": null,
"terminalOwner": "ISP       6829-BUDONI",
"terminalCurrency": "GBP",
"terminalAmount": 0,
"entryModeDescription": "Unknown",
"currencyCode": "EUR",
"otherCurrencyCode": null,
"fxRate": 1,
"amount": -550,
"beginAvailableBalance": 7580.27,
"availableBalance": 7030.27,
"clearedAmount": -500,
"beginLedgerBalance": 8080.27,
"ledgerBalance": 7580.27,
"pendingAmount": 0,
"labels": ["Label123",
"Holiday2022"
],
"references": ["EXPORTED"
],
"documentCount": 0,
"noteCount": 0,
"alertCount": 0,
"transactionRefId": "6cd43ad7-b40b-46fc-9a56-021cddf6147e",
"corporateLabelRelationships": [{"groupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"groupName": "OVERLOAD GROUP 251c70e6-5966-4b0d-b6c0-8446a7c7f5c5",
"labelCode": "a88c6f02-df0b-4420-88b7-4267964a3984",
"labelName": "Food & Beverage",
"alternativeValue": "12345",
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "80cc6303-d1c1-43df-92ed-0a1f21df0368",
"operation": {"flow": "CreateCorporateLabelRelationship",
"task": "CorporateLabelRelationship.Create"
},
"state": "Completed"
}
}
]
},
{"cardId": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--eccf37ca-1ded-4f30-bfa3-10fcac3e41a0",
"id": "36d23d15-ba45-40c4-85bf-db41e7504ac9",
"entryDateTime": "2022-01-21T09:08:58.509445Z",
"utcTransactionDateTime": "2022-01-21T10:45:15.547396Z",
"localTransactionDateTime": "2022-01-21T05:39:15",
"cardTransactionType": "AtmWithdrawal",
"responseCode": "000",
"responseDescription": "Approved",
"authNumber": "895367",
"description": "ATM Withdrawal",
"mcc": "6011",
"merchantCategory": null,
"terminalCountry": "IT",
"terminalState": "ITA",
"terminalCity": "BUDONI",
"terminalLocation": null,
"terminalOwner": "ISP       6829-BUDONI",
"terminalCurrency": "GBP",
"terminalAmount": 0,
"entryModeDescription": "Unknown",
"currencyCode": "EUR",
"otherCurrencyCode": null,
"fxRate": 1,
"amount": -550,
"beginAvailableBalance": 7580.27,
"availableBalance": 7030.27,
"clearedAmount": -500,
"beginLedgerBalance": 8080.27,
"ledgerBalance": 7580.27,
"pendingAmount": 0,
"labels": null,
"references": null,
"documentCount": 0,
"noteCount": 0,
"alertCount": 0,
"accountingCode": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Card

Get cards

Get cards associated with the account

Authorizations:

OAuth2

query Parameters

accountId	string Example: accountId=5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardholderId	integer <int64> Example: cardholderId=400012345678 Card holder identifier to search for
pageSize	integer <int32> Example: pageSize=10 Page size
cursor	string Example: cursor=8de298de-6ba6-44c7-b00f-529672f2f522 Cursor to get the next or previous page

Responses

Response samples

200

Content type

application/json

{"next": "https://api.centtrip.com/api/v2/cards?cursor=bb1991d980ac4009b7a6eef850fce747",
"value": [{"id": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--bf73ba8c-95c4-4fc1-86e4-eef52906f9e1",
"name": "John Smith",
"cardholderId": 400000545635,
"status": "Open"
},
{"id": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--6b5c2b0d-e152-4d92-9ed6-b57d703d89db",
"name": "Talia Adamson",
"cardholderId": 400000545692,
"status": "IssuedNotActive"
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card balance

Get balances associated with the card

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"currencyCode": "EUR",
"availableBalance": 7030.27,
"ledgerBalance": 7580.27
},
{"currencyCode": "GBP",
"availableBalance": 130.27,
"ledgerBalance": 7580.27
},
{"currencyCode": "USD",
"availableBalance": 7080.27,
"ledgerBalance": 7580.27
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transactions

Get transactions associated with the card

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier

query Parameters

startDateTime	string or null <date-time>
endDateTime	string or null <date-time>
currency	string or null
pageSize	integer or null <int32>
prevDateTime	string or null <date-time>
nextDateTime	string or null <date-time>
excludedRefIds	Array of strings or null <uuid>

Responses

Response samples

200

Content type

application/json

{"value": [{"id": "f824ae9e-8640-48e0-b833-b8284ced4938",
"entryDateTime": "2022-01-21T09:16:29.443636Z",
"utcTransactionDateTime": "2022-01-21T10:45:15.547398Z",
"localTransactionDateTime": "2022-01-21T05:39:15",
"cardTransactionType": "AtmWithdrawal",
"responseCode": "000",
"responseDescription": "Approved",
"authNumber": "895999",
"description": "ATM Withdrawal",
"mcc": "6011",
"merchantCategory": null,
"terminalCountry": "IT",
"terminalState": "ITA",
"terminalCity": "BUDONI",
"terminalLocation": null,
"terminalOwner": "ISP       6829-BUDONI",
"terminalCurrency": "GBP",
"terminalAmount": 0,
"entryModeDescription": "Unknown",
"currencyCode": "EUR",
"otherCurrencyCode": null,
"fxRate": 1,
"amount": -550,
"beginAvailableBalance": 7580.27,
"availableBalance": 7030.27,
"clearedAmount": -500,
"beginLedgerBalance": 8080.27,
"ledgerBalance": 7580.27,
"pendingAmount": 0,
"labels": ["Label123",
"Holiday2022"
],
"references": ["EXPORTED"
],
"documentCount": 0,
"noteCount": 0,
"alertCount": 0,
"transactionRefId": "6cd43ad7-b40b-46fc-9a56-021cddf6147e",
"corporateLabelRelationships": [{"groupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"groupName": "My Corporate Label Group",
"labelCode": "a88c6f02-df0b-4420-88b7-4267964a3984",
"labelName": "Food & Beverage",
"alternativeValue": "12345",
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "80cc6303-d1c1-43df-92ed-0a1f21df0368",
"operation": {"flow": "CreateCorporateLabelRelationship",
"task": "CorporateLabelRelationship.Create"
},
"state": "Completed"
}
}
]
},
{"id": "fc60f04b-a196-4163-8f43-e035eb9c28c5",
"entryDateTime": "2022-01-21T12:05:24.942967Z",
"utcTransactionDateTime": "2022-01-20T11:55:15.502002Z",
"localTransactionDateTime": "2022-01-20T05:39:15",
"cardTransactionType": "DebitAdjustment",
"responseCode": "000",
"responseDescription": "Approved",
"authNumber": "547400",
"description": "DebitAdjustment",
"mcc": "6011",
"merchantCategory": null,
"terminalCountry": "IT",
"terminalState": "ITA",
"terminalCity": "BUDONI",
"terminalLocation": null,
"terminalOwner": "ISP       6829-BUDONI",
"terminalCurrency": "GBP",
"terminalAmount": 0,
"entryModeDescription": "Unknown",
"currencyCode": "GBP",
"otherCurrencyCode": null,
"fxRate": 1,
"amount": -320,
"beginAvailableBalance": 450.27,
"availableBalance": 130.27,
"clearedAmount": 7000,
"beginLedgerBalance": 580.27,
"ledgerBalance": 7580.27,
"pendingAmount": 0,
"labels": ["Reconcile",
"TestLabel1"
],
"references": null,
"documentCount": 2,
"noteCount": 0,
"alertCount": 0,
"accountingCode": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transaction documents

Get documents associated with the card transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"id": "adee1cf7-cf14-4453-bfda-bf2a572803c0",
"parentRefId": "fc60f04b-a196-4163-8f43-e035eb9c28c5",
"startDateTime": "2022-01-14T09:48:06.369781",
"endDateTime": null,
"clientRefId": "b27573b6-49af-41c7-ba1b-424d2aeb6020",
"action": "1",
"type": "2",
"value": "receipt.pdf",
"text": "adee1cf7-cf14-4453-bfda-bf2a572803c0"
},
{"id": "42ec0f31-feb4-4759-8516-4df2cde3f569",
"parentRefId": "fc60f04b-a196-4163-8f43-e035eb9c28c5",
"startDateTime": "2022-09-14T15:25:50.16532",
"endDateTime": null,
"clientRefId": "b27573b6-49af-41c7-ba1b-424d2aeb6020",
"action": "1",
"type": "2",
"value": "invoice.pdf",
"text": "42ec0f31-feb4-4759-8516-4df2cde3f569"
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transaction document

Get document associated with the card transaction. The URL for the document is only valid for 5 minutes.

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier
documentId required	string <uuid> Example: adee1cf7-cf14-4453-bfda-bf2a572803c0 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"value": {"id": "adee1cf7-cf14-4453-bfda-bf2a572803c0",
"entityRefId": "ffa0d15d-5197-47b0-8094-8a3b759d5bad",
"url": "https://www.centtrip.com/documents/21e5ec2b-005d-0000-0000-000000000000/adee1cf7-cf14-4453-bfda-bf2a572803c0/Document?Expires=1664459800&Key-Pair-Id=APKAIPH2FJESQQ2HRTBQ&Signature=GeInJxJDarm7o9uC-j50W0qAU2P3XlzwlDRjPdRTMsuiT78Z-Gwfc9401dmjJOcKAegho5fLHOURLbFMpZVQjzpyxONlihl5BeC1FH1Jy4mYeTlqpANOVJWNUG0bUI8CHKrudagK5AQ9DE2IMwFRpmQ1NEr-JSp1Ezbv9Pa3An4SXGnK6o8xKLLGT1GjSPVPmigJ08aBMs3NXWhKwJtAhKVBoESQUz73rY5EK4-derq7RoPO8gr8Q0iVh1DRsvAXxRT2Tx~kDhN1V90uy5cB5Zw3Gr6pTx52b9N8XjpxwSCB~kS5lF8brt~oEDQB5jNFmHxUDqZFjBSKYZT4rYvIcQ__",
"status": "Clean",
"filename": "receipt.pdf"
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Delete document

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier
documentId required	string <uuid> Example: adee1cf7-cf14-4453-bfda-bf2a572803c0 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Create card transaction references

Create references associated with a card transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier

Request Body schema: application/json

journalRefIds	Array of strings or null <uuid>
reference	string or null

Responses

Request samples

Payload

Content type

application/json

{"journalRefIds": ["fc60f04b-a196-4163-8f43-e035eb9c28c5"
],
"reference": "MyReference"
}

Response samples

200

Content type

application/json

{"value": [{"value": {"parentRefId": null,
"startDateTime": "2022-09-29T14:00:31.8224975Z",
"endDateTime": null,
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"refId": "084ad51d-6b99-4047-b32a-b913f334430f",
"action": "Insert",
"type": "Reference",
"value": "MyReference",
"text": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transaction references

Get references associated with the card transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier

Responses

Response samples

200

Content type

application/json

{"value": [{"id": "084ad51d-6b99-4047-b32a-b913f334430f",
"parentRefId": "fc60f04b-a196-4163-8f43-e035eb9c28c5",
"startDateTime": "2022-09-29T14:00:31.822497",
"endDateTime": null,
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"action": "1",
"type": "3",
"value": "MyReference",
"text": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Delete card transaction references

Delete references associated with card transaction

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier

Request Body schema: application/json

reference

string or null

Responses

Request samples

Payload

Content type

application/json

{"reference": "MyReference"
}

Response samples

200
404

Content type

application/json

{"value": {"parentRefId": null,
"startDateTime": "2022-09-29T14:03:41.0990062Z",
"endDateTime": "2022-09-29T14:03:41.0990062Z",
"clientRefId": "f53aa348-d135-4b66-86eb-24a9c13b8146",
"refId": "b75e3f4b-922a-4000-a9b8-d5b08ac56639",
"action": "Delete",
"type": "Reference",
"value": "MyReference",
"text": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get card transaction note

Authorizations:

OAuth2ApiKey

path Parameters

accountId required	string Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1 Account Identifier
cardId required	string Example: 6d98ea63-5f85-4ca5-8ae4-a74cd5aec1a6--61ab2ebe-1a0e-49c8-8fc4-2fc7cc2bc0ea Card Identifier
transactionId required	string <uuid> Example: fc60f04b-a196-4163-8f43-e035eb9c28c5 Transaction Identifier

Responses

Response samples

200

Content type

text/plain

No sample

Corporate Labels

Get label groups associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

query Parameters

id	Array of strings <uuid>
code	Array of strings <uuid>
groupName	Array of strings
allowMobile	boolean
atDateTime	string <date-time>
pageNumber required	integer <int32> >= 1
pageSize required	integer <int32> [ 10 .. 100 ]

Responses

Response samples

200

Content type

application/json

{"value": [{"groupName": "Reconciled Status",
"allowMobile": true,
"accountCode": "000f42bf-0000-0000-0000-000000000000",
"creationDate": "2022-02-09T13:51:37.99195Z",
"codeid": "432920a3-327f-40ef-9859-bbd6e74c0d68",
"scope": "Centtrip",
"code": "519213b4-b07f-46f6-953a-c8ee96252db9",
"codetagaggregate": null,
"id": "71d712b2-c6d4-4d88-9431-1256924c87a7",
"previousId": null,
"State": {"id": "1567a334-bee6-45f9-93c8-18efd302c12e",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-02-09T13:51:37.99195Z",
"endDateTime": null,
"subjectId": "d2d39ea9-8327-11e7-ab5b-0a485d4b220d",
"clientId": "L6FycM3HPh7rfxxC",
"eTag": "7bc92996-fade-4a08-9fe0-d5065f77c65d",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabelGroup",
"task": "CorporateLabelGroup.Create"
}
},
"TagAggregate": null
},
{"groupName": "Sage Cost Code",
"allowMobile": true,
"accountCode": "000f42bf-0000-0000-0000-000000000000",
"creationDate": "2022-02-09T13:52:24.700868Z",
"codeid": "63173380-38ec-435b-9fc2-5c46a8f1b452",
"scope": "Centtrip",
"code": "c6ecccc6-e832-480c-9372-fc4c0d304fb9",
"codetagaggregate": null,
"id": "2c9574be-9157-46b8-b35e-bc93d7884d6f",
"previousId": null,
"State": {"id": "46cf85eb-0fae-400e-801f-ddbb27f8adfb",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-02-09T13:52:24.700868Z",
"endDateTime": null,
"subjectId": "d2d39ea9-8327-11e7-ab5b-0a485d4b220d",
"clientId": "L6FycM3HPh7rfxxC",
"eTag": "6629fe99-775d-4dc7-ad24-296f7036d726",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabelGroup",
"task": "CorporateLabelGroup.Create"
}
},
"TagAggregate": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": {"PageNumber": "1",
"PageSize": "10",
"TotalCount": "507"
}
}

Create label groups associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

groupName	string or null
allowMobile	boolean

Responses

Request samples

Payload

Content type

application/json

{"groupName": "My Corporate Label Group",
"allowMobile": true
}

Response samples

200

Content type

application/json

{"value": {"groupName": "My Corporate Label Group",
"allowMobile": true,
"accountCode": "000f42bf-0000-0000-0000-000000000000",
"creationDate": "0001-01-01T00:00:00",
"codeid": "bfffece2-3864-4323-94ad-4e7c467d8c60",
"scope": "Centtrip",
"code": "925dcf4d-5abf-4337-9235-b062df3104cc",
"codetagaggregate": null,
"id": "3e6d5ddb-6ff0-4222-98ab-c28c8b402fb4",
"previousId": null,
"State": {"id": "eca9f7ae-5238-49fb-95bf-60dd50f12f19",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-29T14:47:22.739062Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "482805f6-0216-4f1b-a096-a2aa08733bdc",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabelGroup",
"task": "CorporateLabelGroup.Create"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Update label groups associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

id	string or null <uuid>
groupName	string or null
allowMobile	boolean
	object (Centtrip.Orchestrator.Api.Models.RequestStateViewModel)

Responses

Request samples

Payload

Content type

application/json

{"id": "3e6d5ddb-6ff0-4222-98ab-c28c8b402fb4",
"groupName": "My Other Corporate Label Group",
"allowMobile": true,
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "482805f6-0216-4f1b-a096-a2aa08733bdc",
"state": "Completed",
"operation": {"flow": "CreateCorporateLabelGroup",
"task": "CorporateLabelGroup.Create"
}
}
}

Response samples

200

Content type

application/json

{"value": {"groupName": "My Other Corporate Label Group",
"allowMobile": true,
"accountCode": "000f42bf-0000-0000-0000-000000000000",
"creationDate": "0001-01-01T00:00:00",
"codeid": "bfffece2-3864-4323-94ad-4e7c467d8c60",
"scope": "Centtrip",
"code": "925dcf4d-5abf-4337-9235-b062df3104cc",
"codetagaggregate": null,
"id": "6792cc78-41fd-473a-a16b-2e67aa74d7be",
"previousId": null,
"State": {"id": "e2cc1181-ef51-4a5c-a3c8-5fb776aeecc4",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-29T14:50:35.719341Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "d3617b34-d2df-4339-886c-d00a64caac0e",
"action": "Update",
"state": "Completed",
"message": null,
"operation": {"flow": "UpdateCorporateLabelGroup",
"task": "CorporateLabelGroup.Update"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Delete label groups associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

id	string or null <uuid>
	object (Centtrip.Orchestrator.Api.Models.RequestStateViewModel)

Responses

Request samples

Payload

Content type

application/json

{"id": "6792cc78-41fd-473a-a16b-2e67aa74d7be",
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "d3617b34-d2df-4339-886c-d00a64caac0e",
"state": "Completed",
"operation": {"flow": "UpdateCorporateLabelGroup",
"task": "CorporateLabelGroup.Update"
}
}
}

Response samples

200

Content type

application/json

{"value": {"groupName": "My Other Corporate Label Group",
"allowMobile": true,
"accountCode": "000f42bf-0000-0000-0000-000000000000",
"creationDate": "0001-01-01T00:00:00",
"codeid": "bfffece2-3864-4323-94ad-4e7c467d8c60",
"scope": "Centtrip",
"code": "925dcf4d-5abf-4337-9235-b062df3104cc",
"codetagaggregate": null,
"id": "6792cc78-41fd-473a-a16b-2e67aa74d7be",
"previousId": null,
"State": {"id": "cdfa226b-1c4f-4fa6-a023-36fcd15c18aa",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-29T14:59:30.251457Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "de950cf0-7df2-4ec1-ba18-fd8cb2bd0a93",
"action": "Delete",
"state": "Deleted",
"message": null,
"operation": {"flow": "DeleteCorporateLabelGroup",
"task": "CorporateLabelGroup.Delete"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Get corporate labels associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

query Parameters

id	Array of strings <uuid>
corporateLabelGroupCode required	Array of strings <uuid>
accountingCode	Array of strings
labelName	Array of strings
code	Array of strings <uuid>
atDateTime	string <date-time>
pageNumber required	integer <int32> >= 1
pageSize required	integer <int32> [ 10 .. 100 ]

Responses

Response samples

200

Content type

application/json

{"value": [{"corporateLabelGroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"accountingCode": "12345",
"labelName": "Food & Beverage",
"codeid": "a5cf9ab9-eaaf-453a-aa3b-e6f93aebcfea",
"scope": "Centtrip",
"code": "9db9e63c-cf65-40ad-b928-f6e142f71f5a",
"codetagaggregate": null,
"id": "674b2b8a-35bf-40a9-8400-4ceb347cbe1f",
"previousId": null,
"State": {"id": "0f0deca4-0b90-4b31-b7d3-1abe3cc494b1",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-30T08:32:54.496481Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "42db498a-f225-4d2a-959f-5d6af893dae4",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabel",
"task": "CorporateLabel.Create"
}
},
"TagAggregate": null
}
],
"isSuccess": true,
"code": 0,
"message": null,
"data": {"PageNumber": "1",
"PageSize": "10",
"TotalCount": "1"
}
}

Create corporate labels associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

corporateLabelGroupCode	string <uuid>
accountingCode	string
labelName	string

Responses

Request samples

Payload

Content type

application/json

{"corporateLabelGroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"accountingCode": "12345",
"labelName": "Food & Beverage"
}

Response samples

200

Content type

application/json

{"value": {"corporateLabelGroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"accountingCode": "12345",
"labelName": "Food & Beverage",
"codeid": "a5cf9ab9-eaaf-453a-aa3b-e6f93aebcfea",
"scope": "Centtrip",
"code": "9db9e63c-cf65-40ad-b928-f6e142f71f5a",
"codetagaggregate": null,
"id": "674b2b8a-35bf-40a9-8400-4ceb347cbe1f",
"previousId": null,
"State": {"id": "0f0deca4-0b90-4b31-b7d3-1abe3cc494b1",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-30T08:32:54.496481Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "42db498a-f225-4d2a-959f-5d6af893dae4",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabel",
"task": "CorporateLabel.Create"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Update corporate label associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

id	string or null <uuid>
accountingCode	string or null
labelName	string or null
	object (Centtrip.Orchestrator.Api.Models.RequestStateViewModel)

Responses

Request samples

Payload

Content type

application/json

{"id": "674b2b8a-35bf-40a9-8400-4ceb347cbe1f",
"accountingCode": "54321",
"labelName": "Food & Beverage",
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "42db498a-f225-4d2a-959f-5d6af893dae4",
"state": "Completed",
"operation": {"flow": "CreateCorporateLabel",
"task": "CorporateLabel.Create"
}
}
}

Response samples

200

Content type

application/json

{"value": {"corporateLabelGroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"accountingCode": "54321",
"labelName": "Food & Beverage",
"codeid": "a5cf9ab9-eaaf-453a-aa3b-e6f93aebcfea",
"scope": "Centtrip",
"code": "9db9e63c-cf65-40ad-b928-f6e142f71f5a",
"codetagaggregate": null,
"id": "542a35ae-6cbb-421e-8e9f-f3b74faffb15",
"previousId": null,
"State": {"id": "8b30f14e-15ef-4e6c-b908-44c1fa3e1530",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-30T08:43:16.589226Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "81262010-2a4a-41de-b849-2f9ed29c3e46",
"action": "Update",
"state": "Completed",
"message": null,
"operation": {"flow": "UpdateCorporateLabel",
"task": "CorporateLabel.Update"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Delete corporate label associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

id	string <uuid>
	object (Centtrip.Orchestrator.Api.Models.RequestStateViewModel)

Responses

Request samples

Payload

Content type

application/json

{"id": "542a35ae-6cbb-421e-8e9f-f3b74faffb15",
"state": {"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"eTag": "81262010-2a4a-41de-b849-2f9ed29c3e46",
"state": "Completed",
"operation": {"flow": "UpdateCorporateLabel",
"task": "CorporateLabel.Update"
}
}
}

Response samples

200

Content type

application/json

{"value": {"corporateLabelGroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"accountingCode": "54321",
"labelName": "Food & Beverage",
"codeid": "a5cf9ab9-eaaf-453a-aa3b-e6f93aebcfea",
"scope": "Centtrip",
"code": "9db9e63c-cf65-40ad-b928-f6e142f71f5a",
"codetagaggregate": null,
"id": "542a35ae-6cbb-421e-8e9f-f3b74faffb15",
"previousId": null,
"State": {"id": "90369a66-86ef-4cfb-934b-5c2866320159",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-30T08:58:36.57621Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "d0612b39-7485-4e5b-aed0-e20a35826c04",
"action": "Delete",
"state": "Deleted",
"message": null,
"operation": {"flow": "DeleteCorporateLabel",
"task": "CorporateLabel.Delete"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": null
}

Set corporate label relationship associated with the account

Authorizations:

OAuth2ApiKey

path Parameters

accountId

required

string

Example: 5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1

Account Identifier

Request Body schema: application/json

transactionRefId	string or null <uuid>
	Array of objects or null (Centtrip.Orchestrator.Api.Models.CorporateLabels.CorporateLabelRelationship.GroupLabelRelation)

Responses

Request samples

Payload

Content type

application/json

{"transactionRefId": "6cd43ad7-b40b-46fc-9a56-021cddf6147e",
"relations": [{"groupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"oldLabelCode": null,
"newLabelCode": "a88c6f02-df0b-4420-88b7-4267964a3984",
"state": null
}
]
}

Response samples

200

Content type

application/json

[{"value": {"corporateLabelCode": "a88c6f02-df0b-4420-88b7-4267964a3984",
"transactionRefId": "6cd43ad7-b40b-46fc-9a56-021cddf6147e",
"codeid": "0d4d7182-96b7-489a-8509-eb61e0565e7f",
"scope": "Centtrip",
"code": "a254adfb-2e79-46bc-90fc-3aa8b906ccee",
"codetagaggregate": null,
"id": "3f6c2ae8-703e-4391-88a4-d0dab79fb2d4",
"previousId": null,
"State": {"id": "d6e66529-223a-418f-95f5-49fe9d984f14",
"refId": "00000000-0000-0000-0000-000000000000",
"startDateTime": "2022-09-30T10:06:05.810513Z",
"endDateTime": null,
"subjectId": "d2d2658a-8327-11e7-ab5b-0a485d4b220d",
"clientId": "Postman",
"eTag": "80cc6303-d1c1-43df-92ed-0a1f21df0368",
"action": "Insert",
"state": "Completed",
"message": null,
"operation": {"flow": "CreateCorporateLabelRelationship",
"task": "CorporateLabelRelationship.Create"
}
},
"TagAggregate": null
},
"isSuccess": true,
"code": 0,
"message": null,
"data": {"GroupCode": "519213b4-b07f-46f6-953a-c8ee96252db9",
"OldLabelCode": null,
"NewLabelCode": "a88c6f02-df0b-4420-88b7-4267964a3984"
}
}
]

Card Transfers

Transfer funds

Transfer funds from card to account and vice versa

Authorizations:

OAuth2

Request Body schema: application/json

accountId required	string Account Identifier
cardId required	string Card Identifier
currencyCode required	string
amount required	number
direction required	string (CardTransferDirection) Enum: "AccountToCard" "CardToAccount"

Responses

Request samples

Payload

Content type

application/json

{"accountId": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1",
"cardId": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--eccf37ca-1ded-4f30-bfa3-10fcac3e41a0",
"currencyCode": "GBP",
"amount": 10.5,
"direction": "AccountToCard"
}

Response samples

200
400

Content type

application/json

{"isSuccess": true,
"message": null,
"data": null
}

Payments

Create payment with recipient

Authorizations:

OAuth2

Request Body schema: application/json

accountId	string Account Identifier
amount	number <double>
reason	string or null
reference	string or null
countryCode	string or null
currencyCode	string or null
firstName	string or null
lastName	string or null
companyName	string or null
email	string or null
phoneNumber	string or null
address1	string or null
address2	string or null
city	string or null
postcode	string or null
state	string or null
bankAccountNumber	string or null
bankIban	string or null
bankSortCode	string or null
bankBic	string or null
bankAba	string or null
bankClabe	string or null
override	string or null
accountHolderPhoneNumber	string or null
additionalDetails	string or null
beneficiaryBankBranchName	string or null
beneficiaryCedulaId	string or null
beneficiaryContactName	string or null
beneficiaryInn	string or null
beneficiaryKbe	string or null
beneficiaryKnp	string or null
beneficiaryPaymentClassification	string or null
beneficiaryRif	string or null
beneficiaryRut	string or null
beneficiaryTaxId	string or null
beneficiaryTrn	string or null
beneficiaryVo	string or null
includeVaTax	string or null

Responses

Request samples

Payload

Content type

application/json

{"accountId": "5e892ea0-dbf8-4b13-bf18-3f40a94d5149--ecd56cb7-21ff-4a59-9ef0-e21af038c9e1",
"currencyCode": "GBP",
"amount": 100.25,
"reason": "My Reason",
"reference": "Invoice #12",
"companyName": "Centtrip",
"address1": "1 Mark Square",
"city": "London",
"postcode": "EC2A 4EG",
"countryCode": "GB",
"bankAccountNumber": "12345678",
"bankSortCode": "112233"
}

Response samples

200

Content type

application/json

{"isSuccess": true,
"message": null,
"data": null
}