Payment Structure
insert_comment
Give Feedback
Payment structures can be confusing, so below is a review of how payment and collections are structured with TxB APIs.
| Level | Description | Potential Statuses |
|---|---|---|
REQUEST LEVEL, identified by a paymentRequestId or collectionRequestId | The top-level envelope that wraps all individual payments or collections. Each paymentRequest contains 1 'funding' account, which can be a GS TxB Deposit account or a 3rd party bank account. Each collectionRequest contains 1 TxB account into which funds will be deposited. Once a request has been ACCEPTED, the individual payments and collections begin processing (and you can begin querying their status) | INITIATED, ACCEPTED, REJECTED |
| BATCH LEVEL | Our Payment APIs do not use Batches, so if you are only using our payments APIs then you can disregard Batches. In file based payments, batches allow you to put multiple sets of payments into a single file | ACCEPTED, PENDING, RELEASED, SETTLED |
PAYMENT LEVEL, identified by a paymentEndToEndId or collectionEndToEndId | The individual payments or collections contained within the Request. TxB supports up to 500 individual payments or collections in a single request | ACCEPTED, PENDING, RELEASED, REJECTED, SETTLED |
insert_comment
Was This Helpful?
Give feedback to help improve Goldman Sachs Developer and serve you better.