Skip to content

README.md

Latest commit

 

History

History
133 lines (95 loc) · 6.89 KB

README.md

File metadata and controls

133 lines (95 loc) · 6.89 KB

Transactions.Settlements

Overview

Available Operations

  • get - Get transaction settlement
  • list - List transaction settlements

get

Retrieve a specific settlement for a transaction by its unique identifier.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setMerchantAccountId('default')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->transactions->settlements->get(
    transactionId: '7099948d-7286-47e4-aad8-b68f7eb44591',
    settlementId: 'b1e2c3d4-5678-1234-9abc-1234567890ab'

);

if ($response->settlement !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
transactionId string ✔️ The unique identifier of the transaction. 7099948d-7286-47e4-aad8-b68f7eb44591
settlementId string ✔️ The unique identifier of the settlement. b1e2c3d4-5678-1234-9abc-1234567890ab
merchantAccountId ?string ➖ The ID of the merchant account to use for this request. default

Response

?GetTransactionSettlementResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*

list

List all settlements for a specific transaction.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
    ->setMerchantAccountId('default')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->transactions->settlements->list(
    transactionId: '7099948d-7286-47e4-aad8-b68f7eb44591'
);

if ($response->settlements !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
transactionId string ✔️ The unique identifier of the transaction. 7099948d-7286-47e4-aad8-b68f7eb44591
merchantAccountId ?string ➖ The ID of the merchant account to use for this request. default

Response

?ListTransactionSettlementsResponse

Errors

Error Type Status Code Content Type
Errors\Error400 400 application/json
Errors\Error401 401 application/json
Errors\Error403 403 application/json
Errors\Error404 404 application/json
Errors\Error405 405 application/json
Errors\Error409 409 application/json
Errors\HTTPValidationError 422 application/json
Errors\Error425 425 application/json
Errors\Error429 429 application/json
Errors\Error500 500 application/json
Errors\Error502 502 application/json
Errors\Error504 504 application/json
errors\APIException 4XX, 5XX */*