API Documentation

GraphQL API

Testing URL: https://api-sandbox.koywe.com/graphql

This URL runs an Apollo explorer instance, in case you want to test directly from your browser.

Contact us at hola@koywe.com to get your Credentials or to schedule a personalized tour around the platoform.

Testing: Our testing API works on the different testnets of major blockchains. We have a limited token stock, so we ask your help in not using them all or returning the tokens once the testing is done.

Queries and Mutations

To send requests to the GraphQL API, you always have to send a POST request to the base URL, including the query and any variable as a JSON object. An example to authenticate using CURL (Authorization header included for illustrative purposes):

$curl --request POST \
>    --header 'content-type: application/json' \
>    --header 'Authorization: Bearer JWTTOKEN' \
>    --url 'https://api-sandbox.koywe.com/graphql' \
>    --data '{"query":"mutation authenticate($input: AuthInput!) {\n  authenticate(input: $input) {\n    token\n  }\n}","variables":{"input":{"clientId":"63631a561f41f8fd18f8c3e0","secret":"supersecretstringFTW"}}}'

In the following examples, we will only write down the JSON object.

Returns a Bearer Token that lasts for 24 hours.

Require: clientId, secret

Optional: email. This field associates the transactions and requests to a specific user account.

1mutation Authenticate($input: AuthInput!) {
2  authenticate(input: $input) {
3    token
4  }
5}
6"variables" :
7{
8  "input": {
9    "clientId": "63631a561f41f8fd18f8c3e0",
10    "secret": "secretpassword",
11    "email": "email@domain.com" # optional
12  }
13}

The next two services allows in a directly way the validation of a final user. The first service sends a code to an email specified by the user’s input. This code must be provided as an input to the second service, where the user will be validated and session data will be returned.

Sends a 6-digit code to the email specified.

1mutation validateAccount($input: ValidateAccountInput!) {
2  validateAccount(input: $input) {
3    _id
4  }
5}
6"variables" :
7{
8  "input": {
9    "email": "email@domain.com",
10    "clientId": "f87aad3as90fe5489bb5099f"
11  }
12}

Value of code must be retrieved from the email sent by the previous service.

1mutation validateCode($input: ValidateCodeInput!) {
2  validateCode(input: $input) {
3    token
4    isIdentify
5    needVerificate
6    identity
7    firstOp
8  }
9}
10"variables" :
11{
12  "input": {
13    "clientId": "40401a5615d9d8fd18f8a0b4",
14    "code": "940577",
15    "email": "example@domain.com"
16  }
17}

Returns supported currency-tokens pairs.

Optional: symbol: Currency symbol to filter pairs. clientId.

1query GetCurrencyTokensV2($input: GetCurrenciesInput!) {
2  GetCurrencyTokensV2(input: $input) {
3    _id
4    name
5    symbol
6    decimals
7    clientId
8    logo
9    locate
10    limits {
11      min
12      max
13    }
14    tokens {
15      _id
16      name
17      symbol
18      decimals
19      logo
20    }
21  }
22}
23"variables":
24{
25  "input": {
26    "symbol": null,
27    "clientId": null
28  }
29}

Returns supported token-currencies pairs.

Optional: symbol. El símbolo del cripto a elección. clientId

1query GetTokenCurrencies($input: GetCurrenciesInput!) {
2  GetTokenCurrencies(input: $input) {
3    _id
4    name
5    symbol
6    decimals
7    logo
8    currencies {
9      _id
10      name
11      symbol
12      decimals
13      locale
14      logo
15      limits {
16        min
17        max
18      }
19    }
20  }
21}
22"variables":
23{
24  "input": {
25    "symbol": null,
26    "clientId": null
27  }
28}

Returns a list of available payment methods with each method’s fees and details for a specific currency.

Require: symbol. currencyId.

Optional: clientId. Payment method list could vary according to this parameter.

1query GetPaymentProviderList($input: GetPaymentProviderListInput!) {
2  getPaymentProviderList(input: $input) {
3    _id
4    name
5    fee
6    image
7    description
8    details
9  }
10}
11"variables":
12{
13  "input": {
14    "symbol": "COP"
15    "clientId": "f87aad3as90fe5489bb5099f"
16    "currencyId": "489bb507aad3as90fe0f"
17  }
18}

Rules for Bank Transfer Payments WIRE: For payments made through bank transfer, the following rules have been established:

  • Users are allowed to have only one active order per client if they use bank transfer as their payment method. This implies that if a user creates a new order via bank transfer, any previous orders will be canceled, and only the latest order will remain active.
  • If a user makes a payment through bank transfer, and the balance is not equal to the order amount, the system will automatically adjust the order. This adjustment is necessary for both payments that are less than the order amount and orders that exceed the specified amount.
This endpoint is deprecated and will be removed in a future version.

Returns a list of available payout providers with each method’s fees and details for a specific currency.

Require: symbol. currencyId.

Optional: clientId. Payment method list could vary according to this parameter.

1query GetPayoutProviderList($input: GetPayoutProviderListInput!) {
2  getPayoutProviderList(input: $input) {
3    _id
4    name
5    fee
6    image
7    description
8    details
9  }
10}
11"variables":
12{
13  "input": {
14    "symbol": "COP"
15    "clientId": "f87aad3as90fe5489bb5099f"
16    "currencyId": "489bb507aad3as90fe0f"
17  }
18}

Get Quote

Returns a quote associated with a quoteId.

1query getQuote($quoteId: String!) {
2  getQuote(quoteId: $quoteId) {
3    amountIn
4    amountOut
5    co2
6    exchangeRate
7    symbolIn
8    symbolOut
9    paymentMethodId
10    koyweFee
11    networkFee
12    validFor
13    validUntil
14  }
15}
16"variables":
17{
18  "quoteId": "63c59396a38c6506a620162f" #Created when calling mutation quote
19}

Create Quote

Requires: amountIn o amountOut, one or the other. symbolIn, symbolOut Optional: paymentMethodId, clientId

1mutation quote($input: QuoteInput!) {
2  quote(input: $input) {
3    quoteId
4    amountIn
5    amountOut
6    co2
7    exchangeRate
8    symbolIn
9    symbolOut
10    paymentMethodId
11    koyweFee
12    networkFee
13    validFor
14    validUntil
15  }
16}
17"variables":
18{
19  "input": {
20    "amountIn": 3716338,
21    "amountOut": 3.3,
22    "clientId": "cse7fj283rkn2x6v7rr",
23    "symbolIn": "CLP",
24    "symbolOut": "ETH",
25    "paymentMethodId": null, # This value corresponds to the _id value returned after calling GetPaymentProviderList
26    "executable": false #set false by default. If value is set true, we store it and return a UUID.
27  }
28}

In all the previous queries, the clientId parameter will be ignored if there’s a JWT Bearer Token in the headers.

Authenticated Queries

All the following queries require a Bearer Token in the headers:

Authorization: Bearer [token]

These user services include: the creation of new user profiles, the ability to update user information, the possibility of consulting user details, and a validation function that checks if the user has provided enough personal data to be able to operate.

See Considerations

Check account

It verifies the user account information and determines if it is possible to perform any operation. If any user data is missing, it could be added through the user update service detailed further below.

1query CheckAccount($input: InputEmailAccountDto!) {
2  checkAccount(input: $input) {
3    canOperate
4    errors {
5      field
6      message
7    }
8    accountStatus
9    nextVerificationDate
10  }
11}
12"variables" :
13{
14  "input": {
15    "email": "email@domain.com"
16  }
17}

Get account

Returns the registered information of the user.

1query GetAccountProfile($input: InputEmailAccountDto!) {
2  getAccountProfile(input: $input) {
3    document {
4      documentNumber
5      documentType
6      country
7      isCompany
8      others {
9        documentNumber
10        documentType
11        country
12      }
13    }
14    address {
15      addressStreet
16      addressCountry
17      addressZipCode
18      addressNeighborhood
19      addressCity
20      addressState
21    }
22    personalInfo {
23      names
24      firstLastname
25      secondLastname
26      nationality
27      gender
28      dob
29      phoneNumber
30      activity
31    }
32    email
33  }
34}
35"variables" :
36{
37  "input": {
38    "email": "email@domain.com"
39  }
40}

Create account

Creates a new user account.

1mutation CreateAccount($input: InputCreateAccountDto!) {
2  createAccount(input: $input) {
3    document {
4      documentNumber
5      documentType
6      country
7      isCompany
8      others {
9        documentNumber
10        documentType
11        country
12      }
13    }
14    address {
15      addressStreet
16      addressCountry
17      addressNeighborhood
18      addressCity
19      addressState
20      addressZipCode
21    }
22    personalInfo {
23      names
24      firstLastname
25      secondLastname
26      nationality
27      gender
28      dob
29      phoneNumber
30      activity
31    }
32    email
33  }
34}
35"variables" :
36{
37  "input": {
38    "email": "email@domain.com",
39    "document": {
40        "documentNumber": "",
41        "documentType": "",
42        "country": "",
43        "isCompany": false,
44        "others": [
45            {
46                "documentNumber": "",
47                "documentType": "",
48                "country": ""
49            }
50        ]
51    },
52    "address": {
53        "addressStreet": "",
54        "addressCountry": "",
55        "addressZipCode": "",
56        "addressCity": "",
57        "addressState": ""
58    },
59    "personalInfo": {
60        "names": "",
61        "firstLastname": "",
62        "secondLastname": "",
63        "nationality": "",
64        "dob": "",
65        "gender": "",
66        "phoneNumber": "",
67        "activity": ""
68    }
69  }
70}

Update account

Updates user data. If an updated email is present, the API validates whether it is a valid email and ensures that another account with that email does not already exist.

If an updated document number or type is present, the API validates that it has a valid format, does not exist on another account, has no executed orders, and initiates an asynchronous validation for mismatching personal data.

The results of the asynchronous validation will be sent to the configured callback. You can find more information in the webhooks section.

1mutation UpdateAccount($input: InputUpdateAccountDto!) {
2  updateAccount(input: $input) {
3    document {
4      documentNumber
5      documentType
6      country
7      isCompany
8      others {
9        documentNumber
10        documentType
11        country
12      }
13    }
14    address {
15      addressStreet
16      addressCountry
17      addressNeighborhood
18      addressCity
19      addressState
20      addressZipCode
21    }
22    personalInfo {
23      names
24      firstLastname
25      secondLastname
26      nationality
27      gender
28      dob
29      phoneNumber
30      activity
31    }
32    email,
33    resultUpdateDocumentNumber
34  }
35}
36"variables" :
37{
38  "input": {
39    "email": "email@domain.com"
40    "document": {
41      "documentNumber": "",
42      "documentType": "",
43      "country": "",
44      "others": [
45        {
46          "documentNumber": "",
47          "documentType": "",
48          "country": ""
49        }
50      ]
51    },
52    "address": {
53      "addressStreet": "",
54      "addressCountry": "",
55      "addressZipCode": "",
56      "addressCity": "",
57      "addressState": "",
58      "addressNeighborhood": ""
59    },
60    "personalInfo": {
61      "names": "",
62      "firstLastname": "",
63      "secondLastname": "",
64      "nationality": "",
65      "dob": "",
66      "activity": "",
67      "gender": "",
68      "phoneNumber": ""
69    },
70    "updateDocumentNumber",
71    "updateDocumentType",
72    "updateEmail"
73  }
74}

Get Account By Filter

Returns the registered document information of a user based on their identification details.

Authentication Required: Include Bearer Token in headers:

Authorization: Bearer [token]

Required Fields:

  • documentNumber: The identification number of the user
  • documentType: The type of identification document (e.g., DNI, RUT, CPF)
  • country: The ISO 3166-1 alpha-3 country code (e.g., CHL, PER, COL)
1query GetAccountByFilter($input: InputAccountFilterDto!) {
2  getAccountByFilter(input: $input) {
3    document {
4      documentNumber    # Unique identifier of the user's document
5      documentType      # Type of identification document
6      country          # ISO 3166-1 alpha-3 country code
7    }
8  }
9}
10"variables" :
11{
12  "input": {
13    "documentNumber": "123456789",
14    "documentType": "DNI",
15    "country": "CHL"
16  }
17}

Possible Errors:

  • 401: Unauthorized - Missing or invalid authentication token
  • 404: Not Found - No account matches the provided filters
  • 400: Bad Request - Invalid input parameters

Create Order

It creates a buy or sell order, returning a UUID to identify it (orderId) and, depending on the payment method, a URL (providedData) to proceed to payment. It accepts amounts for crypto o currency, not both.

For authenticated calls without an email, this parameter must be included to associate the transaction to a specific account.

amountIn or amountOut must be provided as an input, but not both.

On ramp

Requires: destinationAddress, quoteId.

Off ramp

Requires: destinationAddress, quoteId.

Optional: email (required if user is not suthenticated with email), documentNumber (to facilitate bank reconciliation)

Data Description: see Order Rest

1mutation createOrder($input: OrderInput!) {
2  createOrder(input: $input) {
3    orderId
4    amountIn
5    amountOut
6    documentNumber
7    email
8    metadata
9    orderId
10    paymentMethodId
11    providedAction
12    providedAddress
13    quoteId
14    symbolIn
15    symbolOut
16    externalId
17  }
18}
19"variables":
20{
21  "input": {
22    "quoteId": "63e154dbc47d9176668a9af6",
23    "amountIn": 1.100.000,
24    "amountOut": 1,
25    "email": "example@domain.com", #for API calls
26    "documentNumber": null,
27    "paymentMethodId": "632d7fe6237ded3a748112cf",  # This value corresponds to the _id value returned after calling GetPaymentProviderList
28    "destinationAddress": "0x40f9bf922c23c43acdad71Ab4425280C0ffBD697", # Will return error if address is invalid
29    "symbolIn": "CLP",
30    "symbolOut": "ETH",
31    "metadata": null,
32    "externalId":"12A2324A",
33    "callbackUrl": "https://urlexample/mytracing/",
34  }
35}

Get Order

Returns order information. Receives a orderId.

1query getOrder($input: GetOrderInput!) {
2  getOrder(input: $input){
3    orderId # unique identifier
4    quoteId # quote id
5    orderType # currency-crypto for on ramp, crypto-currency for off ramp
6    symbolIn
7    symbolOut
8    amountIn
9    amountOut
10    email
11    exchangeRate
12    koyweFee
13    partnerFee
14    networkFee
15    status # see the webhooks and states docs for more info
16    outReceipt
17    bankAccountId # bank account id for off ramps
18    metaData
19    externalId
20    feesInFiat { #Only if the order has a partnerFee and is greather than 0
21      koyweFee
22      netFee
23      partnerFee
24    }
25    feesInUSD { #Only if the order has a partnerFee and is greather than 0
26      koyweFee #(koyweFee / exchangeRate) truncated to 4 digits after the comma
27      netFee #(netFee / exchangeRate) truncated to 4 digits after the comma
28      partnerFee #(partnerFee / exchangeRate) truncated to 4 digits after the comma
29    }
30    dates {
31      confirmationDate
32      paymentDate
33      executionDate
34      deliveryDate
35    }
36    destinationAddress # wallet address to send or receive tokens
37    paymentMethodId
38    logoIn # logo url for symbolIn
39    logoOut # logo url for symbolOut
40    refund { # refund details for off ramps
41      dates {
42        startDate
43        processDate
44        deliveredDate
45      }
46      destinationAddress
47      transactionReceipt
48    }
49    errors { # error details for off ramps
50      invalidWithdrawalsDetails {
51        _id
52        name
53        bankCode
54        countryCode
55        currencySymbol
56        accountNumber
57        account
58        accountType
59        entityName
60      }
61    }
62  }
63}
64"variables":
65{
66  "input": {
67    "orderId": "02a5f0c7-b9bf-48e0-8b5d-190d2e2f7fc1" #Created when calling mutation Order
68  }
69}

Get Order by ExternalId

Returns order information. Receives a externalId.

1query getOrderByExternalId($input: GetExternalIdOrderInput!) {
2  getOrderByExternalId(input: $input){
3    orderId # unique identifier
4    quoteId # quote id
5    orderType # currency-crypto for on ramp, crypto-currency for off ramp
6    symbolIn
7    symbolOut
8    amountIn
9    amountOut
10    email
11    exchangeRate
12    koyweFee
13    partnerFee
14    networkFee
15    status # see the webhooks and states docs for more info
16    outReceipt
17    bankAccountId # bank account id for off ramps
18    metaData
19    externalId
20    feesInFiat { #Only if the order has a partnerFee and is greather than 0
21      koyweFee
22      netFee
23      partnerFee
24    }
25    feesInUSD { #Only if the order has a partnerFee and is greather than 0
26      koyweFee #(koyweFee / exchangeRate) truncated to 4 digits after the comma
27      netFee #(netFee / exchangeRate) truncated to 4 digits after the comma
28      partnerFee #(partnerFee / exchangeRate) truncated to 4 digits after the comma
29    }
30    dates {
31      confirmationDate
32      paymentDate
33      executionDate
34      deliveryDate
35    }
36    destinationAddress # wallet address to send or receive tokens
37    paymentMethodId
38    logoIn # logo url for symbolIn
39    logoOut # logo url for symbolOut
40    refund { # refund details for off ramps
41      dates {
42        startDate
43        processDate
44        deliveredDate
45      }
46      destinationAddress
47      transactionReceipt
48    }
49    errors { # error details for off ramps
50      invalidWithdrawalsDetails {
51        _id
52        name
53        bankCode
54        countryCode
55        currencySymbol
56        accountNumber
57        account
58        accountType
59        entityName
60      }
61    }
62  }
63}
64"variables":
65{
66  "input": {
67    "externalId": "12A2324A" #Defined when calling mutation Order
68  }
69}

Get Order(s) by txHash

Returns order(s) information. Receives a txHash.

1query GetOrderByTxHash($input: GetTxHashOrderInput!) {
2  getOrderByTxHash(input: $input) {
3    orderId # unique identifier
4    quoteId # quote id
5    orderType # currency-crypto for on ramp, crypto-currency for off ramp
6    symbolIn
7    symbolOut
8    amountIn
9    amountOut
10    email
11    exchangeRate
12    koyweFee
13    partnerFee
14    networkFee
15    status # see the webhooks and states docs for more info
16    outReceipt
17    bankAccountId # bank account id for off ramps
18    metaData
19    externalId
20    feesInFiat { #Only if the order has a partnerFee and is greather than 0
21      koyweFee
22      netFee
23      partnerFee
24    }
25    feesInUSD { #Only if the order has a partnerFee and is greather than 0
26      koyweFee #(koyweFee / exchangeRate) truncated to 4 digits after the comma
27      netFee #(netFee / exchangeRate) truncated to 4 digits after the comma
28      partnerFee #(partnerFee / exchangeRate) truncated to 4 digits after the comma
29    }
30    dates {
31      confirmationDate
32      paymentDate
33      executionDate
34      deliveryDate
35    }
36    destinationAddress # wallet address to send or receive tokens
37    paymentMethodId
38    logoIn # logo url for symbolIn
39    logoOut # logo url for symbolOut
40    refund { # refund details for off ramps
41      dates {
42        startDate
43        processDate
44        deliveredDate
45      }
46      destinationAddress
47      transactionReceipt
48    }
49    errors { # error details for off ramps
50      invalidWithdrawalsDetails {
51        _id
52        name
53        bankCode
54        countryCode
55        currencySymbol
56        accountNumber
57        account
58        accountType
59        entityName
60      }
61    }
62  }
63}
64"variables":
65{
66  "input": {
67    "txHash": "0x7bd90e6285dbf85b48f0907288bdbd79ba082bc2c639640ie8234a5867cgd190"
68  }
69}

List of past orders

Returns a list of all orders associated to the clientId or email specified when completing the user’s authentication.

pagesize: This value has a limit of 300, represents the number of responses per page.

pageNumber: Number of pages shown.

initDate: The initial date from which records are retrieved. Format: YYYY-MM-DD. Records from this date onwards will be included unless an ‘endDate’ is specified.

endDate: The end date until which records are retrieved. Format: YYYY-MM-DD. Only records up to this date will be included. If omitted, records up to the current date are returned.

1query orders($input: PaginationInput!) {
2  orders(input: $input) {
3    pagination {
4      totalCount
5      pageSize
6      pageNumber
7    }
8    data {
9      orderId # unique identifier
10      quoteId # quote id
11      orderType # currency-crypto for on ramp, crypto-currency for off ramp
12      symbolIn
13      symbolOut
14      amountIn
15      amountOut
16      email
17      exchangeRate
18      koyweFee
19      partnerFee
20      networkFee
21      status # see the webhooks and states docs for more info
22      outReceipt
23      bankAccountId # bank account id for off ramps
24      metaData
25      externalId
26      feesInFiat { #Only if the order has a partnerFee and is greather than 0
27        koyweFee
28        netFee
29        partnerFee
30      }
31      feesInUSD { #Only if the order has a partnerFee and is greather than 0
32        koyweFee #(koyweFee / exchangeRate) truncated to 4 digits after the comma
33        netFee #(netFee / exchangeRate) truncated to 4 digits after the comma
34        partnerFee #(partnerFee / exchangeRate) truncated to 4 digits after the comma
35      }
36      dates {
37        confirmationDate
38        paymentDate
39        executionDate
40        deliveryDate
41      }
42      destinationAddress # wallet address to send or receive tokens
43      paymentMethodId
44      logoIn # logo url for symbolIn
45      logoOut # logo url for symbolOut
46      refund { # refund details for off ramps
47        dates {
48          startDate
49          processDate
50          deliveredDate
51        }
52        destinationAddress
53        transactionReceipt
54      }
55      errors { # error details for off ramps
56        invalidWithdrawalsDetails {
57          _id
58          name
59          bankCode
60          countryCode
61          currencySymbol
62          accountNumber
63          account
64          accountType
65          entityName
66        }
67      }
68    }
69  }
70}
71"variables":
72{
73  "input": {
74    "pageNumber": 100,
75    "pageSize": 1,
76    "initDate": "2024-01-01", # optional
77    "endDate": "2024-03-01", # optional
78  }
79}

Add txHash Off Ramp order

Add txHash to an off ramp order. Checks hash is valid for the chosen network.

1  mutation SetTxHashOrder($input: TxHashOrderInputDto!) {
2    setTxHashOrder(input: $input) {
3      orderId
4      message
5    }
6  }
7  "variables":
8  {
9    "input": {
10      "txHash": "0xcef85d0123ea3d2a3c4bdfaa6d13019c1b3d2aa6943e6ba853644d443ab83ad7",
11      "orderId": "ec2af111-acdc-43bb-a0f3-eb1ed1800bbc"
12    }
13  }

Refund Order

Initiate a refund request for an off-ramp order due to errors in the fiat transfer details, returning the orderId and the status of the request.

1mutation OffRampRefund($input: OrderRefundInputDto!) {
2  offRampRefund(input: $input) {
3    code
4    data {
5      orderId
6    }
7    message
8    timestamp
9  }
10}
11"variables":
12{
13  "input": {
14    "orderId": "ec2af111-acdc-43bb-a0f3-eb1ed1800bbc"
15  }
16}
17
18
19#### Example of Error Response
20{
21  "errors": [
22    {
23      "message": "Refund already requested",
24      "status": "INTERNAL_SERVER_ERROR"
25    }
26  ],
27  "data": null
28}
29
30#### Example of Successful Response
31
32{
33  "data": {
34    "offRampRefund": {
35      "code": "REFUND_000",
36      "data": {
37        "orderId": "ec2af111-acdc-43bb-a0f3-eb1ed1800bbc"
38      },
39      "message": "ok",
40      "timestamp": "2024-06-27T22:34:04.685Z"
41    }
42  }
43}

Reprocessing order

Service responsible for reprocessing an order in case of banking errors. The objective is to be able to finalize the transaction of converting crypto to the corresponding currency, where a transfer is made to the bank account associated with the order.

1mutation UpdateOrderWithdrawalDetails($input: UpdateBankInTransactionInput!) {
2  updateOrderWithdrawalDetails(input: $input) {
3    _id
4    name
5    bankCode
6    countryCode
7    currencySymbol
8    accountNumber
9    account
10    accountType
11    entityName
12  }
13}
14"variables":
15{
16  "input": {
17    "orderId": "8bc5b15e-7d9a-4748-b343-cc7d01d20e5f", 
18    "destinationAddress": "665a3d05320291a30b6befef" // New bank account id without errors
19  }
20}

Create Bank Account

Creates a new bank account and saves it for future operations.

optional: bankCode, documentNumber, payoutMethodId (deprecated)

documentNumber is required when the user has not been KYC’d.

1mutation createBankAccount($input: BankAccountInput!) {
2  createBankAccount(input: $input) {
3    _id
4    name
5    bankCode
6    countryCode
7    currencySymbol
8    accountNumber
9    account
10  }
11}
12"variables":
13{
14  "input": {
15    "bankCode": "SANTANDER",
16    "accountNumber": "0123123123",
17    "countryCode": "CHL",
18    "currencySymbol": "CLP",
19    "documentNumber": "12345678",
20    "email": "example@domain.com"
21  }
22}

Colombian Bank validations

To avoid rejections, you need to take into account the requirements of the destination accounts according to the bank to which you are going to send the payment:

BankValidations
NEQUIMaximum account number size must be 11
DAVIVIENDAMinimum account number size must be 12
BANCOLOMBIAMaximum account number size must be 11
DAVIPLATAThe account number must start with 3 and the minimum size must be 10
BANCO CAJA SOCIAL BCSC SAMaximum account number size must be 11
BANCO DE BOGOTÁMaximum account number size must be 9
SCOTIABANK COLPATRIA SAMaximum account number size must be 10
UALAAccount number must be 15 numeric digits

Warning: The bankAccountNumber: Bank Account Number field must contain only numbers and be different from 0.

Get Bank Account

Returns a list of bank accounts the users has associated, filtered using countryCode, currencySymbol and email.

1query getBankAccount($filters: FiltersBankAccount!) {
2  getBankAccount(filters: $filters) {
3    _id
4    name
5    bankCode
6    countryCode
7    currencySymbol
8    accountNumber
9    account
10  }
11}
12"variables":
13{
14  "filters": {
15    "countryCode": "CHL",
16    "currencySymbol": "CLP",
17    "email": "test@koywe.com"
18  }
19}

Delete Bank Account

Deletes a Bank Account from the lists of the client’s bank accounts.

1mutation deleteBankAccount($input: DeleteBankAccountInput!) {
2  deleteBankAccount(input: $input) {
3    _id
4    name
5    bankCode
6    countryCode
7    currencySymbol
8    accountNumber
9    account
10  }
11}
12"variables":
13{
14  "input": {
15    "_id": "63bd75901ea16ea6e23109b5", #Bank account identifier
16    "countryCode": "CHL",
17    "currencySymbol": "CLP"
18  }
19}

Get Bank Info by Country

Returns a list of available banks for a given countryCode.

1query getBankInfoByCountry($countryCode: String!) {
2  getBankInfoByCountry(countryCode: $countryCode) {
3    bankCode
4    name
5    institutionName
6    transferCode
7  }
8}
9"variables":
10{
11  "countryCode": "CHL"
12}