Skip to content

Commit ecd2e69

Browse files
authored
Add COL payment instructions to grid_api (#338)
1 parent 64a7332 commit ecd2e69

5 files changed

Lines changed: 125 additions & 110 deletions

File tree

mintlify/openapi.yaml

Lines changed: 54 additions & 49 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

mintlify/snippets/depositing-funds.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Grid provides two options to fund an account:
33
- Prefund
44
- Just-in-time funding
55

6-
With prefunding, you'll deposit funds into internal accounts via Wire, PIX, or crypto transfers. You can then use the balances as the source of funds for quotes and transfers.
6+
With prefunding, you'll deposit funds into internal accounts via Wire, PIX, hosted payment page, or crypto transfers. You can then use the balances as the source of funds for quotes and transfers.
77

88
With just-in-time funding, you'll receive payment instructions as part of the quote. Once funds arrive, the payment to the receiver is automatically initiated.
99

@@ -64,6 +64,7 @@ Show the payment details prominently in your UI and enable copy / paste:
6464

6565
- Account holder name
6666
- Bank name and routing information (account/routing number, CLABE, PIX key, etc.)
67+
- Payment URL (for COP deposits, redirect the customer to the `paymentUrl` returned in the payment instructions)
6768
- Reference code (if provided)
6869
- Any additional notes from `instructionsNotes`
6970
</Step>

openapi.yaml

Lines changed: 54 additions & 49 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/components/schemas/common/PaymentAccountType.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ enum:
44
- BRL_ACCOUNT
55
- MXN_ACCOUNT
66
- DKK_ACCOUNT
7+
- COP_ACCOUNT
78
- EUR_ACCOUNT
89
- INR_ACCOUNT
910
- NGN_ACCOUNT
Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
title: COP Account
22
allOf:
3-
- $ref: ./BasePaymentAccountInfo.yaml
4-
- $ref: ./CopAccountInfo.yaml
5-
- type: object
6-
required:
7-
- reference
8-
properties:
9-
reference:
10-
type: string
11-
description: Unique reference code that must be included with the payment to
12-
properly credit it
13-
example: UMA-Q12345-REF
3+
- $ref: ./BasePaymentAccountInfo.yaml
4+
- type: object
5+
required:
6+
- paymentUrl
7+
properties:
8+
accountType:
9+
type: string
10+
enum:
11+
- COP_ACCOUNT
12+
paymentUrl:
13+
type: string
14+
format: uri
15+
description: A payment URL where the customer can complete their COP deposit.
16+
example: https://payments.example.com/t/abc123

0 commit comments

Comments
 (0)