Create a braintree payment
How to create a braintree payment via API
To create a new braintree payment, send a POST request to the /api/braintree_payments endpoint, passing the resource arguments in the request body.
Request
POST https://yourdomain.commercelayer.io/api/braintree_payments
Arguments
Body Parameter
Type
Required
type
string
Required
attributes.payment_id
string
Optional
attributes.local
boolean
Optional
attributes.options
object
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.order
object
Required
Example
The following request creates a new braintree payment:
curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/braintree_payments' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "braintree_payments",
    "relationships": {
      "order": {
        "data": {
          "type": "orders",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'On success, the API responds with a 201 Created status code, returning the created resource object:
{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "braintree_payments",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN"
    },
    "attributes": {
      "client_token": "xxxx.yyyy.zzzz",
      "payment_method_nonce": "xxxx.yyyy.zzzz",
      "payment_id": "xxxx.yyyy.zzzz",
      "local": true,
      "options": {
        "customer_id": "1234567890"
      },
      "payment_instrument": {
        "issuer": "cl bank",
        "card_type": "visa"
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "order": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/relationships/order",
          "related": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/order"
        }
      },
      "payment_gateway": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/relationships/payment_gateway",
          "related": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/payment_gateway"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/versions"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/braintree_payments/XAyRWNUzyN/event_stores"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}Last updated

