This endpoint retrieves the accounts and their details
\n","urlObject":{"path":["v1","accounts"],"host":["{{host}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}],"variable":[]}},"response":[{"id":"c1e139d1-0fb9-4ea0-af12-fd75eea18321","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"},{"key":"x-secret-key","value":"{{secret-key}}","type":"text"},{"key":"x-company-id","value":"{{company-id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v1/accounts/?page=1&limit=10","host":["{{host}}"],"path":["v1","accounts",""],"query":[{"key":"page","value":"1"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 21 May 2025 20:59:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3769"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"eb9-VShVsC2SwqvQfjo72dY13PnYLnY\""}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"error\": false,\n \"data\": {\n \"users\": [\n {\n \"id\": \"284b29f3-d255-4ad7-9829-b7ef8b0b3641\",\n \"firstName\": \"alejo\",\n \"lastName\": \"villegas\",\n \"addressLine1\": \"cra123\",\n \"addressLine2\": \"asd\",\n \"zipCode\": \"000\",\n \"phone\": \"3018775627\",\n \"email\": \"alejo2@yopmail.co\",\n \"handle\": \"asdd\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-10-08T14:30:22.000Z\",\n \"account\": [\n {\n \"number\": 85606516,\n \"balance\": 210,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"298808e9-e0f3-4053-a38f-f6624f4a8317\",\n \"firstName\": \"alejo\",\n \"lastName\": \"villegas\",\n \"addressLine1\": \"cra123\",\n \"addressLine2\": \"cra test\",\n \"zipCode\": \"000\",\n \"phone\": \"3018775627\",\n \"email\": \"alejo@yopmail.co\",\n \"handle\": \"test_123\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-19T09:36:55.000Z\",\n \"account\": [\n {\n \"number\": 24875232,\n \"balance\": 505200,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"2df30337-be42-4889-923d-3397703e7503\",\n \"firstName\": \"testing\",\n \"lastName\": \"account\",\n \"addressLine1\": \"Lahore\",\n \"addressLine2\": \"Pakistan\",\n \"zipCode\": \"58000\",\n \"phone\": \"3094602421\",\n \"email\": \"ua40504050@gmail.com\",\n \"handle\": \"testingaccount\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-19T10:37:10.000Z\",\n \"account\": [\n {\n \"number\": 81367176,\n \"balance\": 29055,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"2e55c73c-d14a-402c-8bbf-f193c139a2d9\",\n \"firstName\": \"testing\",\n \"lastName\": \"account1\",\n \"addressLine1\": \"Lahore\",\n \"addressLine2\": \"Pakistan\",\n \"zipCode\": \"58000\",\n \"phone\": \"3094602423\",\n \"email\": \"uma@gmail.com\",\n \"handle\": \"testingaccount1\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-24T15:16:07.000Z\",\n \"account\": [\n {\n \"number\": 23584107,\n \"balance\": 200,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"30f7b9af-2013-434c-b83c-de905652ab54\",\n \"firstName\": \"bao\",\n \"lastName\": \"phe\",\n \"addressLine1\": \"651 N Broad St\",\n \"addressLine2\": \"222x N Broad St\",\n \"zipCode\": \"19709\",\n \"phone\": \"+13093162183\",\n \"email\": \"yun@gmail.coms\",\n \"handle\": \"asdxd\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-11-18T14:43:08.000Z\",\n \"account\": [\n {\n \"number\": 74283548,\n \"balance\": 0,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"5da290ec-d2ff-4774-9759-d282d89eb09e\",\n \"firstName\": \"rachid\",\n \"lastName\": \"tester\",\n \"addressLine1\": \"3 Yucatanweg, Willemstad, Curaçao\",\n \"addressLine2\": \"3 Yucatanweg, Willemstad, Curaçao\",\n \"zipCode\": \"00000\",\n \"phone\": \"59995163266\",\n \"email\": \"rachidblanken@gmail.com\",\n \"handle\": \"d25c445b-dc16-4d21-87d0-30023620b375\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-11-15T13:56:09.000Z\",\n \"account\": [\n {\n \"number\": 94350054,\n \"balance\": 71546,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"6d223589-328e-4ded-ae46-f06c8b7cd991\",\n \"firstName\": \"andres\",\n \"lastName\": \"crepeza\",\n \"addressLine1\": \"cra 321\",\n \"addressLine2\": \"cra test\",\n \"zipCode\": \"000\",\n \"phone\": \"3018775630\",\n \"email\": \"alejo_test2@yopmail.co\",\n \"handle\": \"test_123\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-26T12:52:07.000Z\",\n \"account\": [\n {\n \"number\": 37322295,\n \"balance\": 0,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"734faabe-7b28-40b9-9558-1b8141526897\",\n \"firstName\": \"testing\",\n \"lastName\": \"account1\",\n \"addressLine1\": \"Lahore\",\n \"addressLine2\": \"Pakistan\",\n \"zipCode\": \"58000\",\n \"phone\": \"3094602422\",\n \"email\": \"um@gmail.com\",\n \"handle\": \"testingaccount1\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-19T19:45:08.000Z\",\n \"account\": [\n {\n \"number\": 54245823,\n \"balance\": 0,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"78e9d94f-5ad6-4a62-8b1c-81e81b4be02e\",\n \"firstName\": \"alejo\",\n \"lastName\": \"villegas\",\n \"addressLine1\": \"cra123\",\n \"addressLine2\": \"asd\",\n \"zipCode\": \"000\",\n \"phone\": \"3018775627\",\n \"email\": \"juanes4w@yopmail.co\",\n \"handle\": \"asdd\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-09-19T05:15:18.000Z\",\n \"account\": [\n {\n \"number\": 16066008,\n \"balance\": 49225879,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n },\n {\n \"id\": \"83ef42f1-3ec2-4e58-b972-12e1b736540a\",\n \"firstName\": \"test\",\n \"lastName\": \"test\",\n \"addressLine1\": \"cra123\",\n \"addressLine2\": \"asd\",\n \"zipCode\": \"000\",\n \"phone\": \"3018775628\",\n \"email\": \"test@gmail.cpm\",\n \"handle\": \"test\",\n \"status\": 2,\n \"kycStatus\": 1,\n \"createdAt\": \"2024-10-11T00:42:17.000Z\",\n \"account\": [\n {\n \"number\": 76736120,\n \"balance\": 0,\n \"status\": 1,\n \"currency\": \"USD\"\n }\n ]\n }\n ],\n \"count\": 27\n }\n}"}],"_postman_id":"794724c5-fc1b-4a63-a377-664f07cd2276"},{"name":"Create Account","id":"a885f75d-f4ef-439a-95fe-0702b132b38c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"},{"key":"x-secret-key","value":"{{secret-key}}","type":"text"},{"key":"x-company-id","value":"{{company-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"d3574800-e15e-4292-8ad4-608d465acbc4\",\n \"firstName\": \"Cristian\",\n \"lastName\": \"Ramirez\",\n \"addressLine1\": \"cra123\",\n \"addressLine2\": \"asd\",\n \"city\": \"Medellín\",\n \"zipCode\": \"000\",\n \"country\": \"Colombia\",\n \"phone\": \"3011365977\",\n \"email\": \"c.ramirez@girasol.cw\",\n \"handle\": \"user aditional info\",\n \"kycResponse\": \"Your KYC response\",\n \"id2\": \"Second id\",\n \"currency\": \"USD\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/accounts/create-account","description":"Creates a new user associated with a specific company
\ncompanyId [string, required]: The unique identifier for the company.
firstName [string, required]: The first name of the user.
lastName [string, required]: The last name of the user.
addressLine1 [string, required]: The primary address of the user.
addressLine2 [string, required]: The secondary address of the user.
city [string, required]: The city where the user resides.
zipCode [string, required]: The user's postal code, 000 if not apply.
country [string, optional]: The country where the user resides.
phone [string, required]: The user's contact number. with + and area code.
email [string, required]: The user's email address.
handle [string, required]: The unique username for the user.
kycResponse [string, required]: KYC response used by the end user for validations (if it’s a JSON, convert it to a string).
id2 [string, Optional]: Supplied by the provider, is value of the secondary identifier.
Currency [string, Optional]: Currency of the account (USD or ANG at this time).
Create an additional account in a different currency than the one previously created.
\nHTTP Method: POST
Endpoint: {{host}}/v1/accounts/create-additional-account
The request body must be in JSON format and include the following parameters:
\naccountNumber [Number, required]: Initial account number. (in other Currency)
\nCurrency [string, optional]: Currency of the account (e.g., USD or XCG).
The response will return a JSON object with the following structure:
\nstatusCode: Indicates the status of the request (e.g., 0 for success).
error: A boolean indicating whether an error occurred.
data: An object containing the following fields:
email: The email address associated with the account (empty if not applicable).
accountNumber: The account number generated (0 if not applicable).
currency: The currency of the account (empty if not applicable).
{\n \"statusCode\": 0,\n \"error\": true,\n \"data\": {\n \"email\": \"\",\n \"accountNumber\": 0,\n \"currency\": \"\"\n }\n}\n\n| Transaction ID | ","User Balance | ","Currency | ","Description | ","Created At | ","Master Account Balance | ","
|---|---|---|---|---|---|
| {{response.data.transactionId}} | ","{{response.data.userBalance}} | ","{{response.data.currency}} | ","{{response.data.description}} | ","{{response.data.createdAt}} | ","{{response.data.MasterAccountBalance}} | ","
This endpoint allows the user to perform a cash-in transaction to their account
\ncompanyId (string): The ID of the company.
accountNumber (number): The account number for the transaction.
amount (number): The amount to be cashed in.
message (string): An optional message for the transaction, This message will be reflected in the user’s transaction notes.
This endpoint is used to perform a cash-out transaction from the user's account.
\nRequest Body
\ncompanyId (string): The ID of the company.
accountNumber (number): The account number for the transaction.
amount (number): The amount to be cashed out.
message (string): An optional message for the transaction.
Response
The response will include the status of the cash-out transaction, including the following fields:
statusCode (number): The status code of the transaction.
error (boolean): Indicates if an error occurred.
data (object): The transaction data including:
transactionId (number): The ID of the transaction.
userBalance (number): The user's balance after the transaction.
currency (string): The currency used for the transaction.
description (string): A description of the transaction.
createdAt (string): The timestamp of the transaction.
MasterAccountBalance (number): The master account balance after the transaction.
This endpoint allows the user to perform a peer to peer transaction.
\nRequest Body
\ncompanyId (string): The ID of the company.
originAccountNumber (number): The account number from which the amount will be transferred.
destinarionAccountNumber (number): The account number to which the amount will be transferred.
amount (number): The amount to be transferred.
message (string): An optional message for the transaction.
Response
The response will include the status of the peer to peer transaction.
{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"originBalance\": {\n \"type\": \"number\"\n },\n \"currency\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint allows to update the status to 2 to inactivate it
\ncompanyId [string, required]: The ID of the company.
accountNumber [number, required]: The account number.
status [number, required]: The inactive status for the account (INACTIVE = 2).
This endpoint retrieves the customer information for a specific account.
\ncustomer-info-id (number): The unique identifier for the customer information.GET {{host}}/v1/accounts/customer-info/14507214\n\nThe response will be a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"error\": boolean,\n \"data\": {\n \"accountNumber\": number,\n \"balance\": number,\n \"email\": string,\n \"firstName\": string,\n \"lastName\": string,\n \"phone\": string,\n \"addressLine1\": string,\n \"addressLine2\": string,\n \"city\": string,\n \"status\": number,\n \"createdAt\": string\n }\n}\n\nThis endpoint retrieves the transactions for a specific account.
\naccount-id (number): The unique identifier for the account.GET {{host}}/v1/accounts/transactions/66851827\n\nThe response will be a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"error\": boolean,\n \"data\": {\n \"transactions\": [\n {\n \"amount\": number,\n \"transactionId\": string,\n \"merchant\": string,\n \"currency\": string,\n \"transactionCurrency\": string,\n \"createdAt\": string\n }\n ]\n }\n}\n\nThis endpoint retrieves the transactions for a specific account.
\naccount-id (number): The unique identifier for the account.GET {{host}}/v1/accounts/transactions/66851827\n\nThe response will be a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"error\": boolean,\n \"data\": {\n \"transactions\": [\n {\n \"id\": number,\n \"amount\": number,\n \"type\": number,\n \"transactionId\": string,\n \"merchant\": string,\n \"currency\": string,\n \"transactionCurrency\": string,\n \"createdAt\": string,\n \"user\": {\n \"id\": string,\n \"firstName\": string,\n \"lastName\": string,\n \"phone\": string,\n \"email\": string,\n \"handle\": string,\n \"id2\": null,\n \"createdAt\": string\n },\n \"card\": null\n }\n ]\n }\n}\n\nThis endpoint retrieves the customer information based on the provided email.
\nemail (string): The email address of the customer.GET {{host}}/v1/accounts/customer-info-by-email/alejo1@yopmail.co\n\nThe response will be a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"error\": boolean,\n \"data\": {\n \"accountNumber\": number,\n \"balance\": number,\n \"email\": string,\n \"firstName\": string,\n \"lastName\": string,\n \"phone\": string,\n \"addressLine1\": string,\n \"addressLine2\": string,\n \"city\": string,\n \"status\": number,\n \"createdAt\": string\n }\n}\n\nThis endpoint retrieves the card transactions for a specific account.
\ncard-id (string): The unique identifier for the card.GET {{host}}/v1/accounts/card-transactions/1fe39679-07e6-49a5-8ef7-deb6bb3bb935\n\nThe response will be a JSON object with the following schema:
\n{\n \"statusCode\": number,\n \"error\": boolean,\n \"data\": {\n \"transactions\": [\n {\n \"id\": number,\n \"amount\": number,\n \"type\": number,\n \"transactionId\": string,\n \"merchant\": string,\n \"currency\": string,\n \"transactionCurrency\": string,\n \"createdAt\": string,\n \"user\": {\n \"id\": string,\n \"firstName\": string,\n \"lastName\": string,\n \"phone\": string,\n \"email\": string,\n \"handle\": string,\n \"id2\": null,\n \"createdAt\": string\n },\n \"card\": null\n }\n ]\n }\n}\n\nIn this section, you will find how to manage accounts. This includes creating a new account, founding each account, and changing account status.
\n","_postman_id":"aafe2ffe-47bf-4b17-86f6-92ca0773a6f3"},{"name":"Cards","item":[{"name":"Create Card","id":"a076a7ed-ba3f-422e-aab5-11ffecd3d4c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api-key}}"},{"key":"x-secret-key","value":"{{secret-key}}"},{"key":"x-company-id","value":"{{company-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address1\": \"calle 53A# 77-11\",\n \"address2\": \"Apto 44\",\n \"zipCode\": \"051043\",\n \"state\": \"antioquia\",\n \"city\": \"medellin\",\n \"firstName\": \"andres\",\n \"lastName\": \"cepeda\",\n \"phone\": \"+573194236735342\",\n \"nameForPrint\": \"Alejandro Villegas\",\n \"accountNumber\" : 37322295\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/cards/create-card","description":"Physical card creation
\nThis endpoint is used to create a new phyisical card.
\nRequest Body
\naddress1: (string) The first line of the address.
\naddress2: (string) The second line of the address.
\nzipCode: (string) The zip code of the address.
\nstate: (string) The state of the address.
\ncity: (string) The city of the address.
\nfirstName: (string) The first name of the card holder.
\nlastName: (string) The last name of the card holder.
\nphone: (string) The phone number of the card holder.
\nnameForPrint: (string) The name to be printed on the card.
\naccountNumber: (number) The account number associated with the card.
\nid2: (string) Supplied by the provider, is value of the secondary identifier
\nResponse Body
\n{\n \"cardId\": \"string\",\n \"cardNumber\": \"string\",\n \"expirationDate\": \"string\",\n \"status\": \"string\"\n}\n\nThis endpoint is used to create a new virtual card.
\nfirstName (string): The first name of the card holder.
\nlastName (string): The last name of the card holder.
\nphone (string,): The phone number of the card holder.
\nnameForPrint (string): The name to be printed on the card.
\naccountNumber (number, required): The account number associated with the card.
\nSupplied by the provider, is value of the secondary identifier
\nid2: (string) Supplied by the provider, is value of the secondary identifier
\nThe response of this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"cardStatus\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"number\"\n },\n \"cardId\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\n{\n \"statusCode\": 0,\n \"error\": true,\n \"data\": {\n \"message\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"cardStatus\": \"\",\n \"type\": 0,\n \"cardId\": \"\"\n }\n}\n\nThis endpoint is used to change the PIN of a card.
\ncardId (string): The ID of the card for which the PIN needs to be changed.
\nold_pin (string): The current PIN of the card.
\nnew_pin (string): The new PIN to be set for the card.
\nThe response of this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"cardStatus\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"number\"\n },\n \"cardId\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint is used to activate a new card. The HTTP PATCH request is sent to {{host}}/v1/cards/activate-card with the following payload in the raw request body type:
{\n \"cardId\": \"fa2f46d8-1679-48e0-8c96-39b841 ...\",\n \"pin\": \"1234\",\n \"cvv\": \"859\",\n \"lastFour\": \"7894\"\n}\n\ncardId: The ID of the card to be activated (string)
pin: The PIN of the card (string)
cvv: The CVV of the card (string)
lastFour: Last four digits of the card (string)
The examples of responses for this request are:
\n{\"statusCode\": 0,\"error\": false,\"data\": { \"message\": \"Card activated successfully\", \"cardId\": \"fa2f46d8-1679-48e0-8c96-39b841 ...\", \"cardStatus\": \"active\"}}
\n{\"statusCode\": 0,\"error\": true,\"data\": { \"message\": \"Error message\", \"cardId\": \"\", \"cardStatus\": \"\"}}
\nThis endpoint is used to freeze a specific card by sending an HTTP PATCH request to the endpoint {{host}}/v1/cards/fa2f46d8-1679-48e0-8c96-39b84141403c/freeze.
This request does not require a request body.
\nThe response will contain the following fields:
\nstatusCode (number): Indicates the status code of the response.
error (boolean): Indicates whether an error occurred.
data (object): Contains the following properties:
message (string): A message related to the response.
cardId (string): The ID of the card affected by the request.
cardStatus (string): The status of the card after the freeze operation.
Example response:
\n{\n \"statusCode\": 0,\n \"error\": true,\n \"data\": {\n \"message\": \"\",\n \"cardId\": \"\",\n \"cardStatus\": \"\"\n }\n}\n\n| Status Code | ","Error | ","Message | ","Card ID | ","Card Status | ","
|---|---|---|---|---|
| {{response.statusCode}} | ","{{response.error}} | ","{{response.data.message}} | ","{{response.data.cardId}} | ","{{response.data.cardStatus}} | ","
This endpoint is used to unfreeze a specific card.
\nThe response of this request is a JSON schema with the following structure:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"integer\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"cardId\": {\n \"type\": \"string\"\n },\n \"cardStatus\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint is used to block Permanently a specific card.
\nThe response of this request is a JSON schema with the following properties:
\nstatusCode (number): The status code of the response.
\nerror (boolean): Indicates if an error occurred.
\ndata (object): An object containing the following properties:
\nmessage (string): A message related to the card blocking process.
\ncardId (string): The ID of the blocked card.
\ncardStatus (string): The status of the blocked card.
\nThis endpoint retrieves card information list based on the account ID.
\nMethod: GET
\nURL: {{host}}/v1/cards/info-by-account/11147198
{\n \"statusCode\": 0,\n \"error\": true,\n \"data\": {\n \"card\": [\n {\n \"id\": \"\",\n \"nameForPrint\": \"\",\n \"lastDigits\": \"\",\n \"contactNumber\": \"\",\n \"status\": 0,\n \"createdAt\": \"\"\n }\n ]\n }\n}\n\nThis endpoint retrieves the information of a card based on the provided card ID.
\nThe response for this request can be documented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": { \"type\": \"number\" },\n \"error\": { \"type\": \"boolean\" },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"card\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"nameForPrint\": { \"type\": \"string\" },\n \"lastDigits\": { \"type\": \"string\" },\n \"contactNumber\": { \"type\": \"string\" },\n \"status\": { \"type\": \"number\" },\n \"createdAt\": { \"type\": \"string\" }\n }\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the details for a specific card by providing the card's unique identifier.
\nNOTE: Just for dev purposes on physical cards
\nThe response for this request can be documented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"cardRequest\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint retrieves the details for a specific card by providing the card's unique identifier.
\nNOTE: Just for dev purposes on physical cards
\nThe response for this request can be documented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"cardInfo\": {\n \"type\": \"object\",\n \"properties\": {\n \"encryptedData\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n }\n}\n\nImportant: During the onboarding process, the customer must generate a key pair and share the public key with Girasol in order for this method to work.
\nGirasol uses the following configuration for JWE.
\nJWE base64url encoded string
\n\"alg\" (Algorithm) header parameter: ECDH-ES
\n\"enc\" (Encryption Algorithm) header parameter: A256GCM
\nEC curve: P-256
\nThis endpoint returns a list of the cards configured for each company, including both physical and virtual cards.
\nThis request does not require a request body.
\nThe response for this request includes the following fields:
\nstatusCode (number)
error (boolean)
data (object)
message (string)
cardInfo (array)
id (string)
nameForPrint (string)
lastDigits (string)
contactNumber (string)
status (number)
createdAt (string)
Important: During the onboarding process, the customer must generate a key pair and share the public key with Girasol in order for this method to work.
\nGirasol uses the following configuration for JWE:
\nJWE base64url encoded string
\n\"alg\" (Algorithm) header parameter: ECDH-ES
\n\"enc\" (Encryption Algorithm) header parameter: A256GCM
\nEC curve: P-256
\nThis endpoint retrieves the card purchases within a specified card ID.
\nMethod: GET
\nURL: {{host}}/v1/cards/purchases/6489795a-b2a3-44d7-ac2b-6d743fb1edd
Query Parameters:
\ndate_from (string, optional): The start date of the date range (format: YYYY-MM-DD).
date_to (string, optional): The end date of the date range (format: YYYY-MM-DD).
Status: 404
\nContent-Type: application/json
\n{\n \"statusCode\": 0,\n \"error\": true,\n \"data\": {\n \"message\": \"\",\n \"transactionsSum\": 0,\n \"total\": 0\n }\n}\n\nIn this endpoint, a transaction will be created, and a request will be sent to the user’s webhook for transaction confirmation.
\nRequest Body
\ncardId: (string) card is used on the transaction.
\ntransactionType: (string) purchase | reseversal.
\n{\n \"cardId\": \"string\",\n \"transactionType\": \"string\",\n}\n\nThe endpoint is used to send transaction information in realtime, by making an HTTP POST request to {{webhook}}/v1/transaction_info.
\nrequest_type (string): authorization|reversal|notification
\ntransaction_id (string): The ID of the transaction.
\ntransaction_type (string): purchase|withdrawal|cash-disbursement|payment.
\ntransaction (object): Details of the transaction including brand, date, time, service, settlement, account, currency code, reference number, PAN entry, local date, local time, purpose, card presence, cardholder status, and reason code.
\nmerchant (object): Details of the merchant including acquirer ID, merchant ID, MCC, name, city, country, category code, and final authorization.
\namount (object): Details of the amount including transaction amount, additional amount, transaction fee, reconciliation, and cardholder amount.
\nThe response of this request is represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"number\"\n },\n \"error\": {\n \"type\": \"boolean\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\"\n },\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": \"string\"\n },\n \"cardStatus\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"number\"\n },\n \"cardId\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nRule GUID must be provided in the URL to be deleted.
\n","urlObject":{"path":["v1","rules","1234-1234-1234-1234"],"host":["{{ledger-admin}}"],"query":[],"variable":[]}},"response":[{"id":"5ad28e17-b746-4aff-8f0c-f97093e00d6a","name":"Delete","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://ledger-admin.gwap.app/v1/rules/672130a8-3a9f-4575-961b-d837a49bf2db"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"error\": false,\r\n \"data\": {\r\n \"ruleId\": \"672130a8-3a9f-4575-961b-d837a49bf2db\",\r\n \"deleted\": true\r\n }\r\n}"}],"_postman_id":"40c32658-ec8a-4db6-a3ab-d887a788e8dd"},{"name":"Update","id":"0ddffddf-9023-464c-b761-57893249f40c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"},{"key":"x-secret-key","value":"{{secret-key}}","type":"text"},{"key":"x-company-id","value":"{{company-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"validationType\": \"Mcc|Amount|EntryMode\",\r\n \"value\": \"XXX\",\r\n \"amount\": 0,\r\n \"currencyCode\": \"USD\",\r\n \"businessScope\": \"International|Domestic|Both\",\r\n \"rangeType\": \"Daily|Weekly|Monthly\",\r\n \"timeFrame\": {\r\n \"begin\": \"00:00:00\",\r\n \"end\": \"23:59:59\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ledger-admin}}/v1/rules/1234-1234-1234-1234","description":"Rule GUID must be provided in the URL to be deleted.
\n","urlObject":{"path":["v1","rules","1234-1234-1234-1234"],"host":["{{ledger-admin}}"],"query":[],"variable":[]}},"response":[{"id":"580eea19-d799-41a2-a1ff-101495d5ab0b","name":"Update","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"validationType\": \"Mcc|Amount|EntryMode\",\r\n \"value\": \"XXX\",\r\n \"amount\": 0,\r\n \"currencyCode\": \"USD\",\r\n \"businessScope\": \"International|Domestic|Both\",\r\n \"rangeType\": \"Daily|Weekly|Monthly\",\r\n \"timeFrame\": {\r\n \"begin\": \"00:00:00\",\r\n \"end\": \"23:59:59\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://ledger-admin.gwap.app/v1/rules/1234-1234-1234-1234"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0ddffddf-9023-464c-b761-57893249f40c"},{"name":"List Rules Per Owner","id":"d8473efe-a4dc-4bff-9cb8-a7791fe90d1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{api-key}}","type":"text"},{"key":"x-secret-key","value":"{{secret-key}}","type":"text"},{"key":"x-company-id","value":"{{company-id}}","type":"text"}],"url":"{{ledger-admin}}/v1/rules/owner/1234-1234-1234-1234","description":"This endpoint is used to retrieve a set of rules created under a Sub Issuer, Product or single card.
\nBy sending the:
\nCard ID, the api will return all the rules created under a specific card.
\nProduct ID, the API will return all the rules created under a account range.
\nSub Issuer ID, the API will return all the rules created under the company ID.
\nThis collection enables the configuration of business rules for transaction authorizations. Rules can be customized at multiple levels, including issuer, subissuer, BIN, product type, and individual card.
\nEach rule defines conditions based on several parameters, such as:
\nAuthorized amount: Daily, weekly, or monthly limits on authorized amounts.
\nMCC (Merchant Category Code): Rules can be created based on MCCs, allowing configuration of transaction limits per specific merchant categories.
\nEntry mode: Rules can be defined for specific entry modes (e.g., swipe, chip, contactless).
\nBusiness Scope: Rules can be filtered to apply on Domestic, International transactions or both.
\nLet's break it down how to set ut the rules per type.
\nMCC (Merchant Category Code):
\nvalue: Must contain a 4 digit code related to the MCC that the rule must be applied on, or * if it applies to all MCCs.
\namount: contains the maximum transaction amount the cardholder can do in the specified MCC. Otherwise must be set as 0.
\ncurrencyCode: Currently the system only supports USD.
\nbusinessScope: Accepts Domestic, International and Both. Used to set whether the rule applies only to national or domestic transactions. or both too.
\ntimeframe: Contains the begin and end times where the rule is going to be applied.
\nbegin: Format: \"HH:MM:SS\"
\nend: Format: \"HH:MM:SS\"
\nEntryMode
\nvalue: Accepts clts, chip, mag-stripe, manual or ecommerce
\namount: Contains the maximum transaction amount the cardholder can do in the specified entry mode. Otherwise must be set as 0.
\ncurrencyCode: Currently the system only supports USD.
\nbusinessScope: Accepts Domestic, International and Both. Used to set whether the rule applies only to national or domestic transactions. or both too.
\ntimeframe*: Contains the begin and end times where the rule is going to be applied.
\nbegin: Format: \"HH:MM:SS\"
\nend: Format: \"HH:MM:SS\"
\nAmount
\nvalue: Must contain the maximum total amount allowed in the period defined on the field \"rangeType\".
\namount: Must be 0
\ncurrencyCode: Currently the system only supports USD.
\nbusinessScope: Accepts Domestic, International and Both. Used to set whether the rule applies only to national or domestic transactions. or both too.
\nrangeType: Accepts Daily, Weekly, Monthly determines the period the rule will check to sum the total amount.
\nThese rules ensure fine-grained control over transactions, enhancing security and flexibility in transaction management.
\n